home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / dwnsrs57.zip / DOWNSORT.SCR < prev    next >
Text File  |  1993-06-27  |  104KB  |  2,356 lines
  1. :userdoc sec='Maximus Download File Sort and List Utility (OS/2 and DOS)'
  2. .*
  3. .* For printing: use Bookmaster profile.
  4. .*
  5. .* This file also compilable by IPFC (just ignore the errors!).
  6. .*
  7. :prolog.
  8. .*
  9. .* ==========================================================
  10. .* Translate macros for IBM host printing
  11. .*
  12. .dm on3270 on
  13. .if &$SYS ne pc .ti ╔  10 ╦  13 ╗  30 ╠  31 ╬  21 ╣  23
  14. .if &$SYS ne pc .ti ╚  12 ╩  22 ╝  32 ═  33 ║  11
  15. .if &$SYS ne pc .ti ┌  10 ┬  13 ┐  30 ├  31 ┼  21 ┤  23
  16. .if &$SYS ne pc .ti └  12 ┴  22 ┘  32 ─  33 │  11
  17. .if &$SYS ne pc .ti ╓  10 ╥  13 ╖  30 ╟  31 ╫  21 ╢  23
  18. .if &$SYS ne pc .ti ╙  12 ╨  22 ╜  32
  19. .if &$SYS ne pc .ti ╒  10 ╤  13 ╕  30 ╞  31 ╪  21 ╡  23
  20. .if &$SYS ne pc .ti ╘  12 ╧  22 ╛  32
  21. .if &$SYS ne pc .ti   35   25   26   36
  22. .dm off
  23. .*  ╔═╦════╗   ┌─┬────┐   ╓─╥───╖   ╒═╤═══╕      right arrow
  24. .*  ╠═╬════╣   ├─┼────┤   ╟─╫───╢   ╞═╪═══╡      left arrow
  25. .*  ║ ║    ║   │ │    │   ║ ║   ║   │ │   │      up arrow
  26. .*  ╚═╩════╝   └─┴────┘   ╙─╨───╜   ╘═╧═══╛      down arrow
  27. .dm off3270 on
  28. .if &$SYS ne pc .ti ╔ ╔ ╦ ╦ ╗ ╗ ╠ ╠ ╬ ╬ ╣ ╣ ╚ ╚ ╩ ╩ ╝ ╝ ═ ═ ║ ║
  29. .if &$SYS ne pc .ti ┌ ┌ ┬ ┬ ┐ ┐ ├ ├ ┼ ┼ ┤ ┤ └ └ ┴ ┴ ┘ ┘ ─ ─ │ │
  30. .if &$SYS ne pc .ti ╓ ╓ ╥ ╥ ╖ ╖ ╟ ╟ ╫ ╫ ╢ ╢ ╙ ╙ ╨ ╨ ╜ ╜
  31. .if &$SYS ne pc .ti ╒ ╒ ╤ ╤ ╕ ╕ ╞ ╞ ╪ ╪ ╡ ╡ ╘ ╘ ╧ ╧ ╛ ╛
  32. .if &$SYS ne pc .ti            
  33. .dm off
  34. .*
  35. .* Bookmaster tags voor deze macro's:
  36. .*
  37. .aa on3270 on3270
  38. .aa off3270 off3270
  39. .* ==========================================================
  40. .*
  41. .nameit symbol=VERSION text='5'.
  42. .nameit symbol=SUBVERS text='7'.
  43. .nameit symbol=SUFFIX  text=' '.
  44. .*
  45. :revision id=57 run=yes.
  46. .*
  47. :title.DOWNSORT
  48. &rbl.
  49. Maximus CBCS DOWNload file SORT and List Utility
  50. &rbl.
  51. Version &VERSION..&SUBVERS.&SUFFIX. (OS/2 and DOS)
  52. :etitle.
  53. :author.Rob Hamerling
  54. :date.
  55. :address.
  56. Vianen, The Netherlands
  57. Phone: ++31-3473-72136 (voice)
  58. FIDO-net: 2&colon.512/4.1098
  59. :eaddress.
  60. :docprof rhrfrule=none
  61.          language=english
  62.          figlist=nopage
  63.          tlist=nopage
  64.          ftsep=no
  65.          layout=2
  66.          fbc=no
  67.          toc=12
  68.          ldrdots=yes.
  69. :eprolog.
  70. :frontm.
  71. :tipage.
  72. :toc.
  73. :body.
  74. .* ==============================================================
  75. :h1.About Downsort
  76. :p.Downsort was originated in 1987 as a program for my own use when
  77. I was SYSOP of the Bulletin Board PC-Square (2:512/4), to automatically
  78. generate daily overviews of my download material for the users.
  79. The program name is related to the SORTing of the collection of
  80. DOWNloadable files, in DOWNward time-stamp sequence and an online
  81. Bulletin was the only list that was produced at that time.
  82. PC-Square was running BinkleyTerm and OPUS under DOS, and
  83. file-requesting was not so popular then.
  84. :p.Now PC-Square runs with OS/2, BinkleyTerm and MAXIMUS CBCS.
  85. I'm not SYSOP anymore but still strongly involved.
  86. As a contribution to PC-Square and the large international Bulletin
  87. Board community of MAXIMUS CBCS boards, and in the highly appreciated
  88. spirit of BinkleyTerm, I decided to upgrade my Downsort program to the
  89. current software.
  90. During the past years a lot of improvements and extensions have been
  91. made&colon. many user-configurable options for many more output formats
  92. then the original Downsort.
  93. :p.The only dependency of Downsort on MAXIMUS CBCS is a parameter-file
  94. AREA.DAT, which is usually created with a MAXIMUS utility (SILT(P)),
  95. which itself can be used without actually running MAXIMUS!
  96. This is the way I work for testing of Downsort.
  97. :p.:hdref refid=ahis. gives an impression of recent history.
  98. :p.Downsort is now developed in an OS/2 environment, but it is
  99. distributed as 'family'-application: it runs under OS/2 and DOS.
  100. :rev refid=57.
  101. :p.Downsort is in its 6-th year of development and has entered a period
  102. where life becomes more and more complicated.
  103. While adding new features, I have tried to maintain compatibility.
  104. This is the main cause of complications.
  105. Maybe in one of the newer versions I have to leave this compatibility in
  106. favour of maintainability and user-friendliness.
  107. In anticipation of this, please do not use undocumented features, or
  108. styles of usage that are not described in this document.
  109. :erev refid=57.
  110. .* --------------
  111. :h2.Registration and Shareware Fee
  112. :p.Downsort is a $ 0.00 Shareware Program.
  113. This means (to me) that you respect the commonly known rules for
  114. shareware, but you don't have to pay me anything.
  115. :p.Registration is voluntary&colon. please send me a netmail message
  116. with your name and (net-)address if you are a regular user of Downsort
  117. as SYSOP.
  118. That gives me an impression of the usage and the impact of changes to
  119. Downsort.
  120. :p.If you tell me that you are running Downsort on your Bulletin Board
  121. as service to your users, and you appreciate to be mentioned, I'll add
  122. your name to the reference list in :hdref refid=ause..
  123. .* --------------
  124. :h2.Warranty
  125. :p.For this price?
  126. You must be kidding!
  127. But I'll listen to your complaints and suggestions, and if time permits,
  128. I'll work on the improvements you suggested.
  129. .* --------------
  130. :h2.Acknowledgements
  131. :p.I would like to thank all users that contributed with constructive
  132. remarks and encouraging appraisals.
  133. Without doubt Emmanuel Sandorfi of 2&colon.320/5 holds the record in
  134. number of suggestions and amount of additionally required programming
  135. effort.
  136. He also provided some additional title-fonts (2 and 3).
  137. :p.I also would like to thank the regular users (SYSOP's of Bulletin
  138. Boards) who made Downsort much more popular than I ever dreamed of!
  139. A collection of geographically dispersed Boards can be found in
  140. :hdref refid=ause..
  141. .* =============================================
  142. :h1.Overview
  143. :p.Downsort is a program to make lists of available download files
  144. for Bulletin Board Systems, especially MAXIMUS CBCS.
  145. The different types of lists are each for a specific audience
  146. (online bulletin board user, file-requestor, SYSOP) and purpose
  147. (all files, recent acquisitions).
  148. Within each type there are many ways to customise the contents
  149. (selection on user-privilege or user-interest), and format
  150. (sort-sequence of files, titles, logo, etc).
  151. :p.Downsort can produce the following report-types :fnref refid=usys.
  152. for you:
  153. :fn id=usys.For the target audience the distiction between 'user' and
  154. 'sysop' is strictly the author's view!
  155. :efn.
  156. (:hp2.all these can be produced in one run:ehp2.).
  157. :ul.
  158. .*
  159. :li.user-lists
  160. :ul compact.
  161. :li.BBS-list, a colorful overview for :hp2.online:ehp2. users of
  162. MAXIMUS CBCS
  163. :li.NEW-list of the most recent files
  164. (as a response to a file-request of 'NEWFILES')
  165. :li.ALL-list for a complete overview in a file-group per area
  166. (as a response to a filerequest of 'FILES' of 'ALLFILES')
  167. :li.IPF-list similar contents as ALL-list, but in a different
  168. presentation format (VIEW-able under OS/2)
  169. :li.GBL-list for a complete overview over the area-boundaries,
  170. as an alternative for ALL-list if you don't want to bother
  171. file-requestors with your area-structure
  172. :eul.
  173. .*
  174. :li.SYSOP lists:
  175. :ul compact.
  176. :li.ORPHAN-report as a help with management of the contents of your
  177. area's and directories, and to correct possible upload problems or
  178. inconsistencies
  179. :li.DUP-list for a list of duplicate filenames as a help to control your
  180. disk-space and with version management.
  181. :li.OKFile for (Binkley) File Requests.
  182. :li.EMI-list for a list of new file arrivals to be included in an
  183. announcement message.
  184. :li.Updated FILES.BBS files
  185. :eul.
  186. .*
  187. :eul.
  188. :p.The lists can be generated for different privilege levels,
  189. and be customised to a very high extend to present your system as you
  190. like it to be seen by your users (headers, log, etc).
  191. At the same time Maximus (and OPUS) conventions are reflected in the
  192. way the file information is presented.
  193. :p.A sample of most of these lists can be found in :hdref refid=lsmp..
  194. :p.In short: Downsort is a very versatile tool to manage your database
  195. of files, both in an OS/2 and DOS environment.
  196. .* ------------------------
  197. :h2.Purpose and Objectives
  198. :p.Downsort is designed for the following purposes:
  199. :ol.
  200. :li.Produce different overviews of files which are available for
  201. download by online users of the Bulletin Board and by File Requestors.
  202. QUICK and EASY file retrieval is the main goal for the lists.
  203. Therefore many lists-types and within a type several variations
  204. should be available for SYSOP and users.
  205. :li.Should not disclose files to users (file-requesters) without
  206. positive agreement by SYSOP.
  207. :li.Detect discrepancies between the contents of FILES.BBS and the
  208. corresponding download directory, such as:
  209. :ul compact.
  210. :li.The directory contains so called :hp2.orphan:ehp2.-files, which have
  211. no descriptive entry in FILES.BBS.
  212. :li.FILES.BBS contains entries of which the file in not in the directory
  213. (is 'offline').
  214. This may be on purpose!
  215. :eul.
  216. :li.Must be able to be run unattended (typically overnight).
  217. The file-access privilege system of a Bulletin Board System like Maximus
  218. CBCS should be respected by the reports.
  219. :eol.
  220. .* ==============================================
  221. :h1 id=guide.User's Guide
  222. :p.This chapter explains the possibilities of Downsort.
  223. Parameter specifications will be covered in :hdref refid=specs..
  224. .* --------------------------------
  225. :h2.Initial setup
  226. :p.When you are going to use Downsort for the first time, you have to
  227. make a number of decisions.
  228. Below you'll find a kind of check-list, which is setup to help you with
  229. a logical sequence of tasks to make the use of Downsort succesful.
  230. It does NOT give detailed specifications, these can be found in
  231. :hdref refid=specs..
  232. :p.The specifications will be put into a configuration file
  233. Downsort.CFG, which may contain information about:
  234. :ol.
  235. .*
  236. :li.Data Collection
  237. :p.File information will be collected from:
  238. :ul compact.
  239. :li.Privilege and download path-information from AREA.DAT
  240. :li.Actual file-information from download directories
  241. :li.FILES.BBS files for file descriptions
  242. :eul.
  243. .*
  244. :li.List Type Selection
  245. :p.Downsort can produce the following report types for you (all in one run).
  246. :ul compact.
  247. :li.ORPHAN-report for SYSOP use only
  248. :li.BBS-list for :hp2.online:ehp2. users of MAXIMUS CBCS
  249. :li.NEW-list(s) for a list of the most recent files
  250. :li.ALL-list(s) for a complete overview in a file-group per area
  251. :li.IPF-list(s) same as ALL-list, but in a different presentation format
  252. (VIEW-able under OS/2,
  253. there is a special IP2-list for OS/2 2.0).
  254. :li.GBL-list(s) for a complete overview over area-boundaries
  255. :li.DUP-list(s) for a list of possibly duplicate filenames
  256. :li.OKFile(s) for (Binkley) File Requests
  257. :li.EMIFile(s) to for a list of file arrivals over the last period
  258. :li.Updated FILES.BBS files
  259. :eul.
  260. .*
  261. :li.File selection
  262. :p.Reporting of file-information can be limited by:
  263. :ul compact.
  264. :li.Reporting privilege: only those files up to a certain privilege
  265. level will be listed
  266. :li.Area INclude or EXclude: for sub-selection for special interest
  267. groups
  268. :li.Number of files or period (days, weeks or months) to be reported
  269. :eul.
  270. .*
  271. :li.List Customisation
  272. :p.The layout of the lists can be jazzed-up with:
  273. :ul compact.
  274. :li.BLOCK-title and its font
  275. :li.TopTitle, SubTitle, BottomTitle, Include (logo-) file
  276. :li.Sorting sequence of area's in ALL-list (unsorted, name, include)
  277. :li.Sorting sequence of files (unsorted, date, filename)
  278. :li.Truncation or wrapping of file descriptions
  279. :li.Area- or file-privilege information
  280. :li.Message and Warning texts
  281. :rev refid=57.
  282. :li.Handling of Avatar codes in comment lines (strip or mimic).
  283. :erev refid=57.
  284. :eul.
  285. :p.All in the language which suites your audience best.
  286. :eol.
  287. :p.The sample Downsort.CFG file (see :hdref refid=acfg.) contains
  288. defaults and a brief information to help you with the
  289. parameter specifications.
  290. :p.Below you can find some more explanation.
  291. .* ----------------------------
  292. :h2.Data Collection
  293. .*
  294. :h3.AREA.DAT
  295. :p.A MAXIMUS file 'AREA.DAT' is absolutely required by Downsort.
  296. It is however not necessary to run MAXIMUS itself,
  297. the AREA.DAT file is created with SILT(P) from the MAXIMUS package.
  298. You can use this utility without the other MAXIMUS stuff.
  299. In fact I do that myself (NOT running a MAXIMUS board)!
  300. If you run Downsort in a directory without AREA.DAT, then you should use
  301. specify the filespec for AREA.DAT.
  302. It allows also to specify a different AREA.DAT file than the one that is
  303. used by your MAXIMUS.
  304. :p.With SILT(P) you may build a special AREA.DAT for exclusive use by
  305. Downsort, with different, less, or even more directories!
  306. Probably much more convenient is the use of AreaINclude or
  307. AreaEXclude in Downsort.CFG to limit the contents of the lists to
  308. a group of area's, that you want to report together, while you use the
  309. regular AREA.DAT.
  310. A combination of a 'special' AREA.DAT and AreaIN/EXcludes is another
  311. option to obtain areagroups.
  312. :p.Remember: The combination of area privilege in AREA.DAT and the
  313. report-privilege specification in Downsort.CFG may restrict the contents
  314. of reports.
  315. AreaINclude is subordinate to this and will work only for the collection
  316. of area's within these privilege limits.
  317. :p.If Downsort reports a memory constraint (see also :hdref refid=perf.),
  318. you may use these techniques as circumvention: exclude one or more of
  319. the file area's and rerun Downsort.
  320. .*
  321. :h3.FILES.BBS
  322. :p.Downsort uses the information in AREA.DAT to locate the description
  323. files, usually called FILES.BBS.
  324. So either the ListFile specification in AREA.DAT, or the download
  325. directory to locate them (Maximus default).
  326. .* -----------------------------------
  327. :h2.List Type Selection
  328. :p.Downsort can produce several types of output reports,
  329. indicated by type of list.
  330. The following list types are available:
  331. .* ---
  332. :h3 id=orphan.ORPHAN report
  333. :p.This is a list of all files in download directories for which
  334. there is no entry in any FILES.BBS file of all areas which have this
  335. directory specified as download path.
  336. The report contains date, area-name and area-path of the orphan.
  337. The entries are sorted on area and filename.
  338. Not reported are MAXIMUS system files like:
  339. FILES.*, *.BAK, DIR.?BS and SYSTEM*.?BS.
  340. :p.If you have more than 1 area pointing to the same download directory,
  341. but with different FILES.BBS files, the orphans are reported for the
  342. first of these areas only.
  343. :note.If there is an entry for a file in FILES.BBS without a
  344. description, the file is NOT considered to be an Orphan!
  345. .* ---
  346. :h3.BBS-list
  347. :p.This is a list of downloadfiles that became recently available
  348. on your system.
  349. File selection is on date, but for presentation the list may be sorted
  350. on date, newest first or on filename.
  351. :p.The list contains compiled MECCA control sequences, for direct use in
  352. MAXIMUS bulletins: a user-privilege sensitive list!
  353. It might be a good idea to put a translated &lbrk.onexit&rbrk. string,
  354. which translates into: &caret.OFpath.
  355. When a user exits from the BBS-list bulletin, it will fall back to the
  356. exit-bulletin.
  357. :p.The length of the file (number of file-entries) may be limited by
  358. parameters:
  359. :ul compact.
  360. :li.file-count
  361. :li.file age in days, weeks or months (30 days)
  362. :li.maximum privilege
  363. :eul.
  364. :p.(never more than available within the privilege limit).
  365. If neither specified it will contain all available files in all download
  366. directories.
  367. :p.To make it easy for you to build a complete MAXIMUS bulletin-file a
  368. user-provided header is included preceding the list and a trailer at the
  369. end of the list.
  370. Header and trailer can be built by SYSOP, and may contain any
  371. information and bulletin-control sequences (a sample is provided).
  372. .* ---
  373. :h3.NEW-list
  374. :p.Basically the same list as above, but in simple ASCII format.
  375. This list is suitable for regular file-requestors as brief overview
  376. of the latest additions, updates or replacements.
  377. .* ---
  378. :h3 id=emi.EMI-list
  379. :p.Basically the same as NEW-list, but more compact:
  380. :ul compact.
  381. :li.contains file also file-time and exact filesize in bytes.
  382. :li.Description wrapping (if used) is overlapping the file-details
  383. except filename.
  384. :eul.
  385. :p.The EMI-list is especially suitable to generate file-arrival messages
  386. (the output should be included by another program).
  387. .* ---
  388. :h3.ALL-list
  389. :p.A list of all downloadfiles by area.
  390. Files of the same area are listed in groups, separated by imbedded
  391. headers with area-name, -description, and -privilege.
  392. Actual status information is provided in the area-header as well:
  393. area-filecount and -bytecount, and latest acquisition (date and
  394. file-name).
  395. :p.At the end a SUMMARY report shows per area: area-title,
  396. file-count, byte-count, and totals.
  397. :p.The size of this list is limited only by the privilege parameter.
  398. The numbers in area-header and summary report show only what is
  399. available for the particular privilege.
  400. :p.You may generate several ALL-lists in one run!
  401. .* ---
  402. :h3.IPF- and IP2-list
  403. :p.Same contents as ALL-list but in a different format.
  404. Only useful for users that run OS/2 (OS/2 version 1.2+ under
  405. Presentation Manager).
  406. This file has the format of an input-file for the Information
  407. Presentation Facility Compiler (IPFC).
  408. :p.There is a separate form of this list (called IP2-list) for OS/2 2.0.
  409. It produces information that can be compiled only with the accompanying
  410. IPF Compiler of the OS/2 2.0 Toolkit.
  411. The result however can be VIEWed under OS/2 1.3!
  412. .* ---
  413. :h3.GBL-list
  414. :p.Similar to ALL-list,
  415. but where ALL-list gives the files in groups per area, the GBL-list
  416. ignores area-boundaries and gives a single group.
  417. It contains an extra column with the area-code for each file, there is
  418. no area-summary.
  419. :p.SYSOP may choose which of both is suitable to make available to
  420. users, and which to use for himself (or even both).
  421. :p.The GBL-list can be used in stead of the ALL-list if your users
  422. prefer searching in the list without having to bother about
  423. area-organisation.
  424. Although one of the original purposes of the GBL-list was checking for
  425. duplicate files, there is now also a special report for this particular
  426. purpose (see :hdref refid=dup.).
  427. .* ---
  428. :h3 id=dup.DUP-list
  429. :p.Simple report of :hp2.possibly:ehp2. duplicate files over the area's.
  430. The format is basically the same as the GBL-list, but only files with
  431. the :hp2.same filename:ehp2. are reported.
  432. 'Offline' files are included in the check, orphans are not!
  433. :p.Please note that the DUP-list may not always contain what you expect.
  434. :rev refid=57.
  435. It can be more or less, for example:
  436. :ul compact.
  437. :li.Downsort looks primarily at filenames only (extension is of second
  438. importance, path is completely ignored).
  439. :li.You may have explicitly excluded area's from the search.
  440. :li.You may have excluded area's by privilege: Downsort completely
  441. ignores area's with a higher privilege than any report asked for.
  442. :li.You have duplicates in 'orphan'-state.
  443. :eul.
  444. :p.These circumstances may give 'false' signals or hide duplicates!
  445. :p.All duplicate files within the privilige-range will be reported,
  446. even when a counterpart has a higher privilege or are orphan (and thus will
  447. not be reported in the DUP-list)!
  448. You may need a file-finder-utility to search for the 'partner'-file
  449. in one of the directories with a higher privilege.
  450. :p.There are very few other parameters applicable to this list.
  451. File descriptions may be specified as truncated or wrapped.
  452. All user-titles are left out and only a sort on filename is
  453. supported.
  454. :p.Suppression of reporting files with equal filenames and different
  455. extensions is possible with the "NonDupEXT" keyword in Downsort.Cfg.
  456. You specify pairs of extensions.
  457. Two files with equal filename and one of each having an extension specified
  458. as 'pair' will not be reported as duplicate.
  459. For example, if you specify:
  460. :xmp.
  461.    NonDupEXT  SDN  SDA
  462. :exmp.
  463. then file pairs xyz.SDN and xyz.SDA will not be reported in the DUP-list.
  464. :p.This pair-exclusion can also be used for more than 2 extensions, but
  465. the exclusion works only for pairs of files.
  466. So then you must specify as many pairs as can be formed.
  467. For example if you want to exclude file combinations like xyz.IDX
  468. xyz.DAT and xyz.EXT, then you should specify:
  469. :xmp.
  470.    NonDupEXT  IDX DAT  IDX EXT  DAT EXT
  471. :exmp.
  472. :warning.The check on duplicates by Downsort works only when you specify all
  473. possible pairs of extensions!
  474. If you fail to specify any possible pair, the Dup-list may contain false
  475. signals.
  476. :ewarning.
  477. :p.Multiple pairs may be specified on a line, and multiple lines are
  478. allowed.
  479. Up to 100 pairs of extensions will be accepted by Downsort in total.
  480. :erev refid=57.
  481. .* ---
  482. :h3 id=okf.OKFile
  483. :p.List filespecifications for file-requests in BinkleyTerm style.
  484. The generated paths in the list obey the following rules:
  485. :ul.
  486. :li.the area-privilege is within the privilege limit of the report
  487. :li.the area is not excluded (by areaEXclude)
  488. :li.the area has at least 1 file within the privilege limit of the
  489. report
  490. :eul.
  491. :p.The paths are sorted on area-name (although the area-name is not part
  492. of the list).
  493. There is no check on duplicate paths.
  494. :p.The list is not jazzed-up with titles, etc, but a file may be included in
  495. front of the list if specified on the OKFileList in Downsort.CFG (see :hdref
  496. refid=acfg.).
  497. This option allows you to insert a list of 'magic' names in the OKFile.
  498. :rev refid=57.
  499. :p.Two formats are available:
  500. :ul compact.
  501. :li.SHORT format with lines in the format "filepath\*.*".
  502. This is the regular format for BinkleyTerm and other mailers.
  503. :li.LONG format with lines in the format: "@filespec  filepath\filespec".
  504. All files have a 'magic'-name assigned and there are no generic file
  505. specifications in the OKFileList.
  506. This prevents directory searches for BinkleyTerm for each file request.
  507. :eul.
  508. :note.Some newer versions of BinkleyTerm can use the file base of Maximus
  509. to find a file even faster.
  510. :erev refid=57.
  511. .* ---
  512. :h3 id=filbbs.FIL-list
  513. :p.New "FILES.BBS" type of file may be (re-)created, one for every area.
  514. The contents of the file-information will be about the same as
  515. the original FILES.BBS, but with the following notes:
  516. :ul compact.
  517. :li.A header is generated with area-name, -title, and -privilege.
  518. Also the total amount of files and bytes and the most recently acquired
  519. new file in this area is part of the header information.
  520. :li.Files with a privilege up to and including the area-privilege
  521. are listed first.
  522. :li.Files can have a privilege other than the area-privilege when the
  523. original FILES.BBS file contains &caret.Pp-sequences ('p' being a
  524. privilege letter).
  525. This construction will be rebuilt by Downsort.
  526. Files with a higher privilege than the area-privilege will follow
  527. after a compiled MECCA-sequence (&caret.Pp) in the new FILES.BBS.
  528. Downsort respects these indicators when reading FILES.BBS,
  529. so all file-privilege information is retained.
  530. This ensures no accidental loss of file-information, and the regular
  531. user won't see more than he should.
  532. :li.Wild-card specifications in the original FILES.BBS are not
  533. propagated to the new FILES.BBS.
  534. :rev refid=57.
  535. :li.The file description is kept internally as a single string
  536. of about 2 KBytes (Maximus 2.0 supports up to 240 bytes!)
  537. When creating FILES.BBS files, this will be the file format (single
  538. record per file-entry).
  539. The original FILES.BBS may contain a (long) single string
  540. description, or multiple (short) multiline descriptions.
  541. When encountering multiline descriptions in input-FILES.BBS, Downsort
  542. concatenates the separate description lines with a single intermediate
  543. space up to a maximum of 2 KBytes.
  544. This will be the output format if the FIL-list is requested.
  545. :li.Comments in FILES.BBS will be preserved :hp3.only:ehp3.
  546. when the Keep-Sequence option is used (specify /K on the FilFileList
  547. line of Downsort.Cfg).
  548. :eul.
  549. :p.Special attention is requested for the following:
  550. :ul compact.
  551. :li.The first 8 lines, :hp2.if comments:ehp2. (starting with a
  552. '-'-character), are discarded,
  553. These are assumed to be the standard header for FILES.BBS of Downsort.
  554. :li.Downsort from version 5.7 on uses the 3 characters:
  555. <-><&delta.><backspace> for each of its header-lines, and will skip all
  556. lines starting with this sequence during the data collection phase, even
  557. when encountered after line 8.
  558. :li.You can include your own file with the /I-option on the FILFilePath
  559. line in Downsort.Cfg in the header of FILES.BBS.
  560. All lines in the include-file for FILES.BBS output will be prefixed by
  561. Downsort with the 3 character sequence mentioned above to make sure that
  562. these will also be 'refreshed' by Downsort.
  563. :eul.
  564. :erev refid=57.
  565. :p.The destination of FILES.BBS-files is not by definition the same as
  566. the origin!
  567. When specified with the "FIL&colon."-parameter (or in the configuration
  568. file), the output may be located in a different directory than the
  569. original input FILES.BBS.
  570. :rev refid=57.
  571. :p.When the output is directed to a separate directory, the files will
  572. be named as follows:
  573. :dl tsize=14 termhi=2.
  574. :dt.FILES.ac
  575. :dd.when :hp2.all:ehp2. areanames (areacodes) of the selected areas in a
  576. single run of Downsort are 3 bytes or less.
  577. :dt.areaname.BBS
  578. :dd.when :hp2.any:ehp2. areaname is longer than 3 bytes.
  579. :edl.
  580. :p.The format of the header will be slightly different.
  581. Font specification (/Fx in FILFileList) works for the second case only.
  582. :erev refid=57.
  583. :p.Manual checking or post-processing by some other program may follow
  584. Downsort, after which the files might be put back on the MAXIMUS
  585. specified position.
  586. .* ------------------------------
  587. :h2.Data Selection
  588. .* ---
  589. :h3.Privilege control
  590. :p.The default file privilege to be shown in the lists is SYSOP.
  591. All files with a higher privilege than the specified (or defaulted)
  592. report-privilege will not appear in the report.
  593. :p.Files without a matching filename-entry in FILES.BBS are treated as
  594. Hidden.
  595. That means that by default these files will not be listed,
  596. unless the 'H' privilege is used on the report-request specification.
  597. :p.If you run a mailer like BinkleyTerm and support file-requests, you
  598. lack the extensive privilege system like Maximus.
  599. The only distiction BinkleyTerm makes with file-request is
  600. 'unknown', 'known' and 'password-protected'.
  601. You may generate multiple download lists with different privilege
  602. indictor, depending if you allow these categories to request different
  603. file collections a sample of this kind of environment is given in
  604. :hdref refid=sampl..
  605. :p.This is not needed for Downsort.BBS, since this file has imbedded
  606. privilege control sequences for MAXIMUS users.
  607. But you should specify a sufficiently high privilege for the BBS-list to
  608. satisfy your most valuable users!
  609. .* ---
  610. :h3.AREA selection
  611. :p.When you need file selections on subject, you can use AreaINclude or
  612. AreaEXclude to limit the lists to files that are part of certain
  613. area-groups.
  614. You should realise that this is the latest selection phase:
  615. privilege selection has taken place already before AreaINclude or
  616. AreaEXclude are processed.
  617. So make sure you specified a sufficiently high report-privilege to get
  618. the proper areas into the group.
  619. .* ---
  620. :h3.Report length
  621. :p.For lists that are meant to show the latest file-information only
  622. (BBS-list and NEW-list), the length of the list can be limited to
  623. a maximum number of file-entries or to file-age in days, weeks or
  624. months.
  625. .*
  626. .* ------------------------------
  627. :h2.List Customisation
  628. .*
  629. :h3.Headers, Titles and Include files
  630. :p.There are several ways to custimise the appearance of the lists for
  631. Downsort.
  632. All items in the following list are optional, but the sequence in the
  633. reports is fixed and as listed:
  634. :dl tsize=12 termhi=2.
  635. :dt.Pre-Title
  636. :dd.Up to 20 lines as very first lines of your lists.
  637. Any text may be specified.
  638. Leading '&tilde.'-characters (tilde) will be treated as full-size required
  639. blanks, mainly to manually align (center) the text in these lines.
  640. There is no automatic centering.
  641. You may have to experiment a little.
  642. :dt.TITLE
  643. :dd.A short title (8-12 characters), that will be magnified to big
  644. BLOCK-letters.
  645. There are 4 block-fonts to choose from.
  646. Not all characters are supported and lower-case will be translated to
  647. upper-case.
  648. The '&tilde.'-character (tilde) will be treated as full-size required
  649. blank, the '&grave.'-character (accent-grave) as half-size required
  650. blank.
  651. :p.If not specified, a default title is generated as Downsortxy, where
  652. xy stands for the current version of Downsort.
  653. :dt.TitleFont
  654. :dd.Number of the font to be used for the BLOCK title.
  655. If specified as 0, the BLOCK-title will NOT be generated at all.
  656. :dt.Include-file
  657. :dd.A text-file to be included.
  658. There will be no manipulation of the contents of this file.
  659. This include-file may be all you need to obtain a fully custimised list.
  660. For the IPF-list this include file will most likely have to contain IPF
  661. tags for proper formatting,
  662. for the OK-file it will be a list of 'magic' name entries.
  663. :dt.Sub-Title
  664. :dd.Up to 20 lines.
  665. These are treated like the Pre-Title lines.
  666. :dt.BottomTitle
  667. :dd.Up to 20 lines as very last lines of the lists.
  668. These follow my 'signature'.
  669. The lines follow the same treatment as Pre-Title lines.
  670. :edl.
  671. :p.The BLOCK-title and Pre-, Sub-, and Bottom-titles are used for all
  672. reports identically, there is no such thing as an 'individual' title
  673. specification for each report.
  674. However the Include-file may be different for each report.
  675. If you want to build more than 1 list but with different 'headings'
  676. or no headings at all, you better forget the Title-options.
  677. In stead make heading-files and use the Include option of the individual
  678. list specifications.
  679. :note.Exceptions:
  680. :ol.
  681. :li.None of the above does apply to the BBS-list.
  682. As it will generally be desirable to imbed (compiled) MECCA control
  683. sequences in this type of lists, this report will include dedicated top
  684. and bottom files (if available in the current default directory).
  685. These files must be called Downsort.HDR (header) and Downsort.TRL
  686. (trailer).
  687. :li.The ORPHAN report will not contain any user-titles.
  688. :li.The FILES.bbs files will not use any of the title-specifications,
  689. but may use an Include-file.
  690. :eol.
  691. :p.:hp2.Recommendation:ehp2.&colon. File-requestors appreciate a header
  692. with a clear indication of the source of the reports.
  693. Many Bulletin Boards use FILES or ALLFILES as 'magic' name,
  694. but that is not very distinctive if you collect lists of different
  695. boards!
  696. So use Downsort's facilities to generate a block-title with your
  697. system-name, or an include file with some kind of logo.
  698. :note.Specification details and samples can be found in Downsort.CFG.
  699. :p.Some SYSOPs do not like to confront their users with privileges.
  700. In most headers there will be a line with the reporting privilege.
  701. This may be suppressed.
  702. .* ---
  703. :h3.File Sorting
  704. :p.The file-entries in the lists can be sorted on different keys:
  705. :ul.
  706. :li.Filedate
  707. :li.Filename
  708. :li.Sequence of FILES.BBS
  709. :eul.
  710. :p.The default sorting sequence depends on the type of list.
  711. Some lists do not support some of these sorting keys.
  712. :note.File sorting has a local scope.
  713. It can be specified for to each listtype individually.
  714. .* ---
  715. :h3.Area Sorting
  716. :p.The order in which the areas are presented in the lists can be
  717. specified:
  718. :ul compact.
  719. :li.Order of AREA.DAT
  720. :li.Sorted alphabetically on areaname
  721. :li.Order of areaINclude statement in Downsort.Cfg
  722. :li.Groupname-order
  723. :eul.
  724. :p.The Groupname-order is a special order based on a popular naming
  725. convention for areas.
  726. Many SYSOPs use areanames with a group-name or -letter followed by a
  727. sequence number.
  728. With groupname sorting the areaname is split - if possible - into a
  729. groupname (if the first character is not be numeric) and a sequence number
  730. (if the last part of areaname is numeric).
  731. Primary sort key is groupname, secundary sortkey is sequence number.
  732. If the first character of the area-name is numeric, the groupname
  733. is empty, and if the last part of the areaname is not numeric, the
  734. second key is empty.
  735. :p.If the ordering does not match your more complicated area naming
  736. convention, you can always fallback on a properly sequenced AREA.DAT,
  737. or on areaINclude sequence.
  738. :p.If Include-order is specified, but AreaINclude is not, then the
  739. order falls back to Group-order.
  740. :p.The area-order specification has a global scope.
  741. It applies to every lists where the areaname is significant, including
  742. summaries in ALL- and IPF-lists.
  743. :p.Default sorting order is 'Group'.
  744. .* ---
  745. :h3.Warnings, Indications, Descriptions and Comments
  746. :ul.
  747. :li.There are two options for long file descriptions
  748. (those that do not fit on a 80-character line):
  749. :ul compact.
  750. :li.Truncation at end-of-line
  751. :li.Wrapping to multiple lines
  752. :eul.
  753. :p.Both options are available for all lists,
  754. but the defaults vary with the type of the report.
  755. .*
  756. :li.Orphan description:
  757. Text that will be reported in the description column of a file, when
  758. for this file no entry in FILES.BBS could be located.
  759. :p.Default: "--- Orphan ---".
  760. .*
  761. :li.Not-Found description:
  762. Text for the description column when the file-entry was found in
  763. FILES.BBS, but there was no description present.
  764. :p.Default: "--- no description available ---".
  765. .*
  766. :li.Offline description:
  767. Text that will replace file-size and file-date, when an entry for this
  768. file was found in FILES.BBS, but the file could not be located in the
  769. download directory.
  770. :p.Default: "** offline **".
  771. .*
  772. :li.Comments in FILES.BBS (mostly used for additional description for
  773. groups of files) will be listed when no sorting is specified (the /K
  774. option for ALL-, IPF- and FIL-lists).
  775. :rev refid=57.
  776. :p.When Downsort encounters Avatar screen handling codes in FILES.BBS
  777. these are stripped of or partially imitated in the output lists (unless
  778. AVAstrip&rbl.No is specified in Downsort.Cfg).
  779. Typical screen handling commands (cursor movement, color settings) are just
  780. stripped, ohers (repeating characters of patterns) are imitated.
  781. :erev refid=57.
  782. .*
  783. :li.Size of a VIEW-page in IPF-list:
  784. The IPF-list of area's with more than 250 file entries will be splitted
  785. into 'parts' to prevent the IPF-compiler message 'page size exceeded'.
  786. But if you have many long descriptions, or wish smaller parts, the
  787. page-size can be altered with a parameter on the IpfFileList line in
  788. Downsort.CFG.
  789. :p.Default: 250.
  790. .*
  791. :eul.
  792. .* ---------------------------
  793. :h2.Miscellaneous report information
  794. .* ---
  795. :h3.File Information in Lists
  796. :ol.
  797. :li.Dates are marked with a 'new'-indicator: a '*' if the file
  798. is only since a week on this system, and a '+' if it is since a month.
  799. Filedates later than the current system date are marked '-' (negative
  800. age).
  801. :li.In every outputfile the filename, MAXIMUS-area name, file-size and
  802. -date, and file-description from FILES.BBS is listed.
  803. A report-line will never display more than 79 characters.
  804. :p.The file-description will be multi-line in ALL-, IPF- and GBL-list
  805. if it is longer than would fit on the standard 79-position line, a
  806. word-wrapping technique is used for readability (line-split on word
  807. boundary).
  808. The description is truncated at end of line in BBS-list and NEW-list.
  809. :p.The -T option will force truncation of the description in all reports,
  810. the -W option will allow multi-line descriptions in all reports.
  811. :p.If a filename is found in FILES.BBS, but no accompanying description,
  812. a "--- no description available ---" will be put in place.
  813. An alternative text may be specified with Downsort.CFG.
  814. :p.Files for which there is no entry in the FILES.BBS (Orphans) are
  815. treated as Hidden files, which are only listed in the reports if the
  816. Hidden privilege is specified.
  817. :note.If you want the orphans to appear in FILES.BBS (or in any other
  818. report), you MUST also request an ORP-list!
  819. :li.'OFFLINE" in stead of file-size and file-date is reported if
  820. FILES.BBS contains an file-entry while the file is not in the
  821. corresponding directory.
  822. :li.The BBS-list contains MAXIMUS authorisation controls
  823. (&caret.PLp-sequences), corresponding to the privilege of the area or the
  824. individual file.
  825. So it is not necessary to make different files for different categories
  826. of MAXIMUS users, even with the default privilege-limit SYSOP a
  827. user will not see the files he/she is not supposed to know about.
  828. :p.Other lists do not contain any privilege information,
  829. the files (or complete area's) above the specified privilege are simply
  830. not listed, however multiple lists can be produced for different
  831. categories of users (based on privilege).
  832. :eol.
  833. .* ---
  834. :h3.File Dates
  835. :p.One of the function of Downsort is sorting on file date.
  836. Since the introduction of HPFS in OS/2 version 1.2, there is not one
  837. single file-date anymore!
  838. A file on an HPFS volume has different values for:
  839. :ul compact.
  840. :li.Creation date
  841. :li.LastAccess date
  842. :li.LastWrite date
  843. :eul.
  844. :p.The date you see normally in DIR-listings is the LastWrite date.
  845. Most SYSOPs will have noticed that ZMODEM uploads and file-attaches
  846. give file-dates corresponding to the (LastWrite-) date of the sending
  847. system.
  848. And most utilities handle only this 'single' date.
  849. That means that old ZMODEM-uploaded files are generally not on top
  850. of the acquisition lists.
  851. :p.But HPFS stores the date of arrival on your system (Creation) as
  852. well.
  853. Downsort handles the Creation date for sorting, but the lists (see
  854. below) contain the 'old fashioned' LastWrite date.
  855. This has the following consequences:
  856. :ul compact.
  857. :li.A new acquisition is on top of lists, if that list is sorted on
  858. date, and are marked in the lists as new by a flag for an 'age' of a
  859. week or a month.
  860. :li.The listed file-date is the 'ordinary' date.
  861. So users can judge for themselves if the file is 'new' for them as well.
  862. :eul.
  863. :note.The LastAccess date is not very relevant for the purposes of
  864. Downsort, although SYSOP may see when it was last downloaded.
  865. :p.Downsort is delivered with a simple DIR-like utility 'HPFSDATE' to
  866. show the three dates of a file on a HPFS volume.
  867. .* ---
  868. :h3.Duplicates
  869. :p.Duplicate filenames are checked if the DUP-list is requested,
  870. and they will be reported only in the DUP-list.
  871. So duplicates may appear in the regular user-lists, which means:
  872. :ul compact.
  873. :li.If a filename.ext is encountered more than once in different
  874. subdirectories of FILES.BBS files, it will appear that many times in the
  875. outputlist.
  876. The file-privilege reflects that of the area where the file belongs to,
  877. unless overridden by a &caret.Px modifier in FILES.BBS.
  878. :li.It may happen that a file is reported as orphan in one area,
  879. and as duplicate in another.
  880. It is likely that the file is found in a common download directory of
  881. more than one area but it is described in the FILES.BBS of a 'secundary'
  882. area, but with the wrong extension.
  883. :eul.
  884. .* ==============================================
  885. :h1 id=specs.Parameter Specifications
  886. :p.This chapter tells you how to customise the configuration file and
  887. what you might specify on the commandline.
  888. :p.A sample configuration file (in :hdref refid=acfg.) is part of the
  889. package.
  890. It contains a brief comments (in Binkley and MAXIMUS style) to help you.
  891. .* --------------------------
  892. :h2 id=hcmd.Commandline parameters
  893. :p.This paragraph deals only with the commandline parameters!
  894. :p.NOTE: Parameters from Downsort.CFG are processed first, commandline
  895. parameters may complete and (partly) override those in the configuration
  896. file.
  897. :p.An explanation of how to read the command syntax diagram can be found
  898. in the (online) OS/2 Command Reference manual.
  899. :xmp.
  900. :cgraphic scale='1.1'.
  901. :on3270.
  902.  
  903.                                       ┌────────────────────────┐
  904.                                       v                        │
  905.  ──┬─────────┬─┬────────┬─ Downsort ────┬────────────────────┬─┴─────┤
  906.    └─ drive ─┘ └─ path ─┘               ├─ @filespec ────────┤
  907.                                         ├─ BBS ─┬──────┬─────┤
  908.                                         │       └─ &colon.p ─┘     │
  909.                                         ├─ NEW ─┬───────┬────┤
  910.                                         │       └─ &colon.pp ─┘    │
  911.                                         ├─ EMI ─┬───────┬────┤
  912.                                         │       └─ &colon.pp ─┘    │
  913.                                         ├─ ALL ─┬───────┬────┤
  914.                                         │       └─ &colon.pp ─┘    │
  915.                                         ├─ IPF ─┬───────┬────┤
  916.                                         │       └─ &colon.pp ─┘    │
  917.                                         ├─ IP2 ─┬───────┬────┤
  918.                                         │       └─ &colon.pp ─┘    │
  919.                                         ├─ GBL ─┬───────┬────┤
  920.                                         │       └─ &colon.pp ─┘    │
  921.                                         ├─ DUP ─┬──────┬─────┤
  922.                                         │       └─ &colon.p ─┘     │
  923.                                         ├─ OK ──┬──────┬─────┤
  924.                                         │       └─ &colon.p ─┘     │
  925.                                         ├─ ORP ──────────────┤
  926.                                         ├─ FIL ─┬──────────┬─┤
  927.                                         │       └─ &colon.fpath ─┘ │
  928.                                         ├─ nnn ─┬────────────┤
  929.                                         │       └── D|W|M ───┤
  930.                                         ├──┬─ /T ─┬──────────┤
  931.                                         │  └─ /W ─┘          │
  932.                                         ├──┬─ /A ─┬──────────┤
  933.                                         │  ├─ /D ─┤          │
  934.                                         │  └─ /K ─┘          │
  935.                                         ├──── /L ────────────┤
  936.                                         ├──┬─ /H ─┬──────────┤
  937.                                         │  ├─ /Q ─┤          │
  938.                                         │  └─ /V ─┘          │
  939.                                         └──── /X ────────────┘
  940. :off3270.
  941. :ecgraphic.
  942. :exmp.
  943. .*
  944. :dl tsize=12 termhi=2.
  945. :dt.@filespec
  946. :dd.The character '@' followed by a complete
  947. :hp2.file specification:ehp2. of the
  948. :hp2.Downsort configuration file:ehp2.
  949. (see :hdref refid=hcfg. for details).
  950. This file will be used to specify processing parameters.
  951. If the file cannot be read, only the commandline parameters are used.
  952. :p.NOTE: The use of a configuration file is mandatory when the file
  953. AREA.DAT is not in the default directory when running Downsort.
  954. :p.Default: Downsort.CFG in current default directory.
  955. .*
  956. :dt.BBS
  957. :dd.Create the BBS-list: Downsort.BBS.
  958. :p.Default: Downsort.BBS will not be created.
  959. .*
  960. :dt.NEW
  961. :dd.Create NEW-list(s): Downsort.N&tilde.p,
  962. where 'p' is the appropriate privilege class (see below).
  963. :p.Default: Downsort.N&tilde.p will not be created.
  964. .*
  965. :dt.EMI
  966. :dd.Create EMI-list(s): Downsort.E&tilde.p,
  967. where 'p' is the appropriate privilege class (see below).
  968. :p.Default: Downsort.E&tilde.p will not be created.
  969. .*
  970. :dt.ALL
  971. :dd.Create ALL-list(s): Downsort.A&tilde.p,
  972. where 'p' is the appropriate privilege class (see below).
  973. :p.nnn-limit does not apply to ALL-list.
  974. :p.Default: Downsort.A&tilde.p will not be created.
  975. .*
  976. :dt.IPF
  977. :dd.Create IPF-list(s): Downsort.I&tilde.p,
  978. where 'p' is the appropriate privilege class (see below).
  979. :p.nnn-limit does not apply to IPF-list.
  980. :p.Default: Downsort.I&tilde.p will not be created.
  981. .*
  982. :dt.IP2
  983. :dd.Create IP2-list(s): Downsort.I&tilde.p,
  984. where 'p' is the appropriate privilege class (see below).
  985. :p.nnn-limit does not apply to IP2-list.
  986. :p.Default: Downsort.I&tilde.p will not be created.
  987. .*
  988. :dt.GBL
  989. :dd.Create GBL-list(s): Downsort.G&tilde.p,
  990. where 'p' is the appropriate privilege class (see below).
  991. :p.nnn-limit does not apply to GBL-list.
  992. :p.Default: Downsort.G&tilde.p will not be created.
  993. .*
  994. :dt.DUP
  995. :dd.Create DUP-list(s): Downsort.DUP.
  996. :p.Only the privilege-specification and WRAP/TRUNC flag apply to
  997. DUP-list.
  998. :p.Default: Downsort.DUP will not be created.
  999. .*
  1000. :dt.OK
  1001. :dd.Create OKFile(s): Downsort.O&tilde.p.
  1002. :p.Only the privilege(s) and include-file specifications apply to the
  1003. OKFile.
  1004. :p.Default: Downsort.O&tilde.p will not be created.
  1005. .*
  1006. :dt.ORP
  1007. :dd.Create ORP-list: Downsort.ORP (orphan report, if any orphans).
  1008. :p.If an orphan report is not requested, no other report will contain
  1009. any orphan information, even when 'Hidden' is specified as reporting
  1010. level.
  1011. :p.Default: Downsort.ORP will not be created.
  1012. .*
  1013. :dt.FIL
  1014. :dd.Create FILES.BBS type of files for each area.
  1015. :p.The specification does not apply to FILES.BBS, a privilege-limit
  1016. cannot be specified and defaults to SYSOP.
  1017. Another privilege limit can be specified however by means of the
  1018. configuration file.
  1019. :p.For each individual area the following convention will be used
  1020. for the name and place of the FILES.BBS list (in this sequence):
  1021. :ol compact.
  1022. :li.If the "FIL&colon." parameter specifies a directory-path, then the
  1023. :rev refid=57.
  1024. :hp2.output:ehp2.-'FILES.BBS'-files of all areas are put in this directory
  1025. with the following naming convention:
  1026. :ol compact.
  1027. :li.When the length of any :hp2.reported:ehp2. areaname is longer than 3
  1028. characters, :hp2.all:ehp2. outputfiles will be called 'areaname.BBS',
  1029. where "areaname" is the name of the area according to Maximus' AREA.DAT.
  1030. :li.Otherwise the outputfile will be called "FILES.ac", where 'ac' is the
  1031. areaname.
  1032. This is the 'old' naming convention (before version 5.7) of Downsort.
  1033. :eol.
  1034. :p.In other words: only one of both naming conventions will be used during a
  1035. single run of Downsort, and if none of the reported area's has a name longer
  1036. than 3 characters it will be the 'old' convention for :hp2.all:ehp2..
  1037. :erev refid=57.
  1038. :p.Previous files in this directory with the same name will be discarded.
  1039. :li.If "ListFile" is specified in Maximus' AREA.CTL file, then that name and
  1040. path will be used.
  1041. :li.Otherwise the file FILES.BBS: will be put in the directory with the
  1042. download files.
  1043. :eol.
  1044. :p.For situations 2 and 3 existing files will be renamed to .BAK
  1045. (older .BAK files will be discarded).
  1046. :p.Default: FILES.BBS-type of files will not be generated.
  1047. .*
  1048. :dt.fpath
  1049. :dd.Optional directory path specification for FILES.BBS-output.
  1050. See the "FIL&colon." parameter for usage.
  1051. :p.Default: none
  1052. .*
  1053. :dt.nnn&lbrk.P&rbrk.
  1054. :dd.If 'nnn' is specified sec (without a trailing letter), then it is
  1055. the maximum :hp3.number:ehp3. of files to be reported in the BBS- and
  1056. NEW-list(s).
  1057. When followed by a character (only D, W and M are allowed), then
  1058. 'nnn' specifies the maximum age of the files in number of
  1059. :hp3.D:ehp3.ays, :hp3.W:ehp3.eeks or :hp3.M:ehp3.onths, to be included
  1060. in NEW- and BBS-lists.
  1061. A maximum value of 32767 can be specified.
  1062. :p.Default: all files up to and including the (specified or default)
  1063. privilege class will be listed..
  1064. .*
  1065. :dt.p
  1066. :dd.Single privilege character.
  1067. :p.Lists only download files with a privilege of up to and including
  1068. privilege 'p'.
  1069. The indicator must be the first character of an existing MAXIMUS
  1070. privilege level (T, D, L, N, W, P, F, E, C, A, S, H).
  1071. No error-message is given for an invalid privilege character,
  1072. there will simply be no file-list for an invalid character!
  1073. :p.For the BBS-list and DUP-list only a single privilege character is
  1074. allowed, the files lists will get the extension of BBS and DUP
  1075. respectively.
  1076. :p.Default: S  (SYSOP):  files of all privilege levels will be listed,
  1077. except HIDDEN files (with real Hidden privilege or files for which no
  1078. entry could be found in FILES.BBS).
  1079. .*
  1080. :dt.pp
  1081. :dd.Multiple privilege characters (minumum 0, maximum 10).
  1082. :p.Make for every valid specified privilege level a download-list
  1083. with files of a privilege of up to and including privilege 'p'.
  1084. The indicator must be the first character of an existing MAXIMUS
  1085. privilege level.
  1086. No error-message is given for an invalid privilege character,
  1087. there will simply be no file-list for an invalid character!
  1088. :p.Applies to ALL-, GBL-, IPF-, NEW- and OK-lists, these are called
  1089. Downsort.A&tilde.p, Downsort.G&tilde.p, Downsort.I&tilde.p,
  1090. Downsort.N&tilde.p and Downsort.O&tilde.p
  1091. respectively, were 'p' represents the applicable privilege character.
  1092. :p.Default: S  (SYSOP):  files of all privilege levels will be listed,
  1093. except HIDDEN files (with real Hidden privilege or files for which no
  1094. entry could be found in FILES.BBS).
  1095. .*
  1096. :dt./T /W
  1097. :dd.Action to be taken if the file description would cause the
  1098. reportline to exceed 79 characters:
  1099. :ul compact.
  1100. :li.T&rbl.-&rbl.:hp4.t:ehp4.runcate the description
  1101. :li.W&rbl.-&rbl.:hp4.w:ehp4.rap the description and provide as many
  1102. reportlines as needed to show the complete description.
  1103. :eul.
  1104. :p.Default: -T for NEW-list and BBS-list, -W for ALL-, IPF- and GBL-list.
  1105. .*
  1106. :dt./A /D /K
  1107. :dd.Sorting method.
  1108. :ul compact.
  1109. :li.A&rbl.-&rbl.Sort the files :hp4.a:ehp4.lphabetically on filename.
  1110. :li.D&rbl.-&rbl.Sort the files on reversed :hp4.d:ehp4.ate sequence
  1111. (newest file on top of list).
  1112. :li.K&rbl.-&rbl.:hp4.k:ehp4.eep lines in sequence of FILES.BBS
  1113. and keep the interfile comment lines.
  1114. :eul.
  1115. :p.When the -A option is selected, an additional header-line will appear
  1116. in the BBS-list and NEW-list, indicating the latest acquisition.
  1117. This line is not needed and will not be done when these lists are sorted
  1118. on date, since the the latest acquisition will be on top of the list!
  1119. :p.The -K option is useful in situations where the files are
  1120. primarily grouped on AREA, i.c. ALL-, IPF- and FIL-list.
  1121. :p.If :hp2.and only if:ehp2. this option specified, any imbedded
  1122. comments in FILES.BBS are copied to the ALL-, IPF- and/or
  1123. FILES.bbs-files.
  1124. :p.Default: -K for FILES.BBS, -D for BBS- and NEW-files, -A for other.
  1125. .*
  1126. :dt./L
  1127. :dd.Generate a LONG OKfile with explicit filenames,
  1128. rather than a list with generic file specifications (path\*.*).
  1129. :rev refid=57.
  1130. For FILES.BBS output it means that file size and file date will be included
  1131. for every file.
  1132. :erev refid=57.
  1133. .*
  1134. :dt./H /Q /V
  1135. :dd.Operating mode
  1136. :ul compact.
  1137. :li.H&rbl.-&rbl.:hp4.h:ehp4.elp:  display screen with essential information
  1138. about running Downsort, such as the command syntax.
  1139. In that case the program will not undertake any other action.
  1140. :li.Q&rbl.-&rbl.:hp4.q:ehp4.uiet:  display only start and finish-message,
  1141. and error messages which prevent the program from proceeding normally.
  1142. :li.V&rbl.-&rbl.:hp4.v:ehp4.erbose:  display a lot of progress messages.
  1143. :eul.
  1144. If neither -Q nor -V is specified, than the number of console messages
  1145. will be 'intermediate': more than -Q, but less than -V.
  1146. :p.Default: none
  1147. .*
  1148. :dt./X
  1149. :dd.Exclude Privilege Indications
  1150. :ul compact.
  1151. :li.X&rbl.-&rbl.e:hp4.x:ehp4.clude privilege indications in all list-types.
  1152. Some SYSOPs want to hide any kind of privilege-system for users and
  1153. file-requesters of their Bulletin Board System.
  1154. With the -X option specified all privilege indications will be
  1155. suppressed.
  1156. :note.This does not apply to the compiled MECCA privilege controls in
  1157. the BBS-list!
  1158. :eul.
  1159. :p.Default: none (privilege indications will be reported).
  1160. .*
  1161. :edl.
  1162. .* ---------------------------------
  1163. :h2.Hints for specifications
  1164. :ol.
  1165. :li.All commandline parameters are optional, may be specified in any
  1166. sequence and are case independent.
  1167. :li.Parameters from the configuration file are processed before those
  1168. from the commandline.
  1169. This has some side-effects, like:
  1170. :ul compact.
  1171. :li.If you specify a specific list in Downsort.Cfg, it will be created
  1172. anyhow, whatever you specify on the commandline.
  1173. :li.However, if you specify privilege values on the commandline, only
  1174. the commandline values will be used, and none from the configuration
  1175. file.
  1176. :li.Commandline parameters have a global meaning, and are applied to all
  1177. lists (if applicable).
  1178. For example: if you specify '-A' on the commandline, all lists will be
  1179. sorted alphabetically on filename.
  1180. :eul.
  1181. :li.Parameters that can be specified with the configuration file only,
  1182. and cannot be overridden with a commandline parameter are:
  1183. :ul compact.
  1184. :li.BLOCK title-text and -font
  1185. :li.Other titles
  1186. :li.Filename and individual list-options
  1187. :li.Privilege for FILES.BBS output
  1188. :li.Replacements of some warnings and messages that may appear in the
  1189. lists.
  1190. :eul.
  1191. :li.Even when specified on the commandline, or in Downsort.CFG,
  1192. the Orphan-report will be generated only if there are any orphans,
  1193. and then the specified parameters apply.
  1194. :li.The IPF-list has to be processed by the Information Presentation
  1195. Facility Compiler (IPFC).
  1196. This compiler is part of the IBM Programmers Development Toolkit version
  1197. 1.2 and 1.3. For the IP2-list the OS/2 2.0 or 2.1 toolkit is needed.
  1198. The following command has to be issued:
  1199. :xmp.
  1200.     IPFC  Downsort.IPF  /INF
  1201. :exmp.
  1202. :p.The option "/INF" is essential (but not documented!) to obtain
  1203. a viewable file.
  1204. Be also sure to have the file Downsort.BMP in your current default
  1205. directory, or in DPATH, as this will be imbedded by the IPF-compiler.
  1206. The result of the compilation is a file Downsort.INF, which can be
  1207. VIEWed with the following command:
  1208. :xmp.
  1209.     VIEW  Downsort
  1210. :exmp.
  1211. :note.
  1212. :ul compact.
  1213. :li.The names "Downsort", "IPF" and "INF" are used here as sample,
  1214. actually the filename depends on the specification in the Downsort
  1215. configuration file, the extensions are the IPFC defaults.
  1216. :li.If VIEW gives garbled columns and hardly readable block-titles,
  1217. then it is most likely that you did not install (or removed) the
  1218. standard fonts that are delivered with OS/2.
  1219. Start the 'control panel utility', select 'installation', 'add fonts'.
  1220. Specify in the 'from'-field C&colon.\OS2\DLL (see HELP of control panel).
  1221. Now choose at least 1 non-proportional font.
  1222. :eul.
  1223. :eol.
  1224. .* --------------------------
  1225. :h2 id=hcfg.Configuration file Parameters
  1226. :p.Almost all processing options may be specified in a configuration
  1227. file.
  1228. This is a somewhat more convenient way to specify processing parameters,
  1229. and provides even more customisation posibilities for the lists.
  1230. It is a good place for the more static parameters of your environment.
  1231. Commandline parameters are nice to create quickly 'another' list
  1232. or a different format (for example wrapped or truncated descriptions).
  1233. The parameters are only mentioned here for completeness,
  1234. see :hdref refid=acfg. for a documented specification sample
  1235. of a configuration file.
  1236. .* -----------
  1237. :h3.Parameters with global scope
  1238. :p.The parameters below influence the execution of Downsort,
  1239. or have impact on :hp2.every:ehp2. list (if it is applicable for that
  1240. list).
  1241. :ul compact.
  1242. :li.File Specification of the MAXIMUS CBCS file 'AREA.DAT'.
  1243. :li.Area Selection
  1244. :li.Sorting order of areas
  1245. :li.List title with BLOCK-characters.
  1246. :li.Font for the BLOCK title.
  1247. :li.Pre-titles, Sub-titles and Bottom-lines in 'text' format
  1248. :li.Descriptive text of orphans, files without a description
  1249. and files for which an entry is found in FILES.BBS, but could not
  1250. be found in the corresponding download directory.
  1251. :li.Maximum number of entries in NEW-list and BBS-list.
  1252. :eul.
  1253. .* -----------
  1254. :h3.Parameters with local scope
  1255. :p.The parameters below are sub-parameters of the xxxFileList keyword.
  1256. :ul compact.
  1257. :li.Up to 10 privileges for NEW-, GBL-, ALL- and IPF-list (each
  1258. resulting in a separate list).
  1259. :li.Alternate output filename (in stead of the default Downsort).
  1260. :li.Directory for the :hp2.output:ehp2. FILES.BBS-lists
  1261. :li.Maximum number of file entries in NEW-list and BBS-list
  1262. :li.File-entry sort sequence (filename or date).
  1263. :li.Wrap or Truncate long file descriptions.
  1264. :li.Title Font selection.
  1265. :li.Suppression of privilege indications in NEW-, ALL-, IPF- and
  1266. GBL-lists.
  1267. :li.Include textfile in NEW-, ALL-, IPF- and GBL-lists, and in FILES.bbs.
  1268. :eul.
  1269. :p.Downsort can generate several lists in a single run, but processes
  1270. only the specifications of a single xxxFileList of the same type.
  1271. If you need different layouts, for example an ALL-list with files sorted
  1272. on date, and another ALL-list with files sorted on filename, then
  1273. you would need 2 invocations of Downsort with different configuration
  1274. files.
  1275. :p.If you specify more than one xxxFileList line of the same type,
  1276. then the paramaters of each of the lines are 'mixed': some will be
  1277. overwritten, some others will remain there from previous specifications.
  1278. It will probably give unwanted effects!
  1279. :p.A sample configuration file is provided.
  1280. A listing of this file is imbedded as :hdref refid=acfg..
  1281. It contains a complete specification with comments on:
  1282. :ul compact.
  1283. :li.which options are available
  1284. :li.how to specify the options
  1285. :eul.
  1286. :p.Read and modify the file as you like.
  1287. Copy the sample file to a save place before you start modifying the
  1288. original Downsort.CFG!
  1289. :p.NOTE: The parameters from Downsort.CFG are processed first, then
  1290. commandline parameters, which may complete and will (partly) override
  1291. those in the configuration file.
  1292. .* =====================================================
  1293. :h1 id=sampl.Sample of Getting organised
  1294. :p.Assume you are runnung MAXIMUS with BinkleyTerm as front end mailer.
  1295. Suppose you make a distinction for file-requestors between Unknown, Known
  1296. and Password-Protected (e.g. corresponding to Disgrace, Normal and
  1297. Privileged MAXIMUS users).
  1298. .* ----------------------------------------------
  1299. :h2.Downsort
  1300. :p.You might have a specification like this:
  1301. :xmp scale='1.1'.
  1302.   Downsort bbs&colon.p new&colon.dnp all&colon.dnp 100
  1303. :exmp.
  1304. :p.In addition to or in place of the specifications in Downsort.CFG,
  1305. this specification produces the following lists:
  1306. :ul.
  1307. :li.Orphan report (only if there are any orphans).
  1308. :li.Downsort.BBS with 100 entries for MAXIMUS users of category Privil.
  1309. Users with a lower privilege will actually see a shorter list
  1310. if the file contains Privil entries.
  1311. :li.For file requestors of the magic filename FILES a list,
  1312. a list with all files
  1313. (with optional titles via Downsort.CFG specifications):
  1314. :ul compact.
  1315. :li.Downsort.A&tilde.D for UNKNOWN file-requestors
  1316. :li.Downsort.A&tilde.N for KNOWN file-requestors
  1317. :li.Downsort.A&tilde.P for Password Protected file-requestors
  1318. :eul.
  1319. :p.Note that each list is a complete list of what is available to
  1320. the user of the specific privilege class,
  1321. but your system will generally contain more files than listed for
  1322. UNKNOWN and KNOWN users!
  1323. :li.For file requests of the magic filename NEWFILES a list
  1324. of the 100 most recent additions to your system
  1325. (with optional titles via Downsort.CFG specifications):
  1326. :ul compact.
  1327. :li.Downsort.N&tilde.D for UNKNOWN file-requestors
  1328. :li.Downsort.N&tilde.N for KNOWN file-requestors
  1329. :li.Downsort.N&tilde.P for Password Protected file-requestors
  1330. :eul.
  1331. :p.Note that each list is 100 entries long, but the contents will
  1332. generally not be quite the same
  1333. (depending on your privilege strategy).
  1334. :eul.
  1335. :p.In general: files, which the requestor is not supposed to know about
  1336. due to his privilege status, will not be on his/her list!
  1337. :note.The counters on top of the lists indicate what your system has
  1338. available in total (including higher privileges), so a clever
  1339. user/file-requester may come up with the question how that is possible:
  1340. explain that he/she has to earn a higher privilege level!
  1341. .* ------
  1342. :h2.BinkleyTerm
  1343. :p.In Binkley.Cfg you should specify for requests of FILES:
  1344. :xmp scale='1.1'.
  1345.   Avail        Downsort.A&tilde.d
  1346.   KnownAvail   Downsort.A&tilde.n
  1347.   ProtAvail    Downsort.A&tilde.p
  1348. :exmp.
  1349. :p.Furthermore you may need to specify different OKFILEs:
  1350. .cp 5
  1351. :xmp scale='1.1'.
  1352.   OKFile       Download.N
  1353.   KnownReqList Download.K
  1354.   ProtReqList  Download.P
  1355. :exmp.
  1356. .cp 16
  1357. :p.And in each of the appropriate filerequest authorisation files
  1358. you should specify the appropriate file-spec:
  1359. :xmp.
  1360. :cgraphic scale='1.1'.
  1361. :on3270.
  1362.  
  1363.  ╔═══════════╦══════════════╦═══════════════╦═══════════════╗
  1364.  ║       in: ║ OKFile       ║ KnownReqList  ║ ProtReqList   ║
  1365.  ║           ║ (Download.N) ║ (Download.K)  ║ (Download.P)  ║
  1366.  ║ for:      ║              ║               ║               ║
  1367.  ╠═══════════╬══════════════╬═══════════════╬═══════════════╣
  1368.  ║ .....     ║ .........    ║ ...........   ║  ........     ║
  1369.  ║ @NEWFILES ║ Downsort.N&tilde.d ║ Downsort.N&tilde.n  ║  Downsort.N&tilde.p ║
  1370.  ║ @FILES    ║ Downsort.A&tilde.d ║ Downsort.A&tilde.n  ║  Downsort.A&tilde.p ║
  1371.  ║ .....     ║ .........    ║ ...........   ║  ........     ║
  1372.  ╚═══════════╩══════════════╩═══════════════╩═══════════════╝
  1373. :off3270.
  1374. :ecgraphic.
  1375. :exmp.
  1376. :p.This will result in sending of the appropriate NEW-list to every
  1377. requester of the magic filename: NEWFILES.
  1378. If you use the second magic filename, then the Avail-lines in
  1379. Binkley.Cfg are not needed, and you might prefer this way.
  1380. :p.Of course if the privilege level of all download area's is the same,
  1381. this construction is not needed,
  1382. but in that case it is unlikely that you have specified KnownAvail and
  1383. ProtAvail!
  1384. :p.Downsort may create a set of OK-files for you.
  1385. The privilege system of MAXIMUS CBCS is used to select the download
  1386. paths in this list.
  1387. .* ===============================================
  1388. :h1.Packaging
  1389. .* ---------------------
  1390. :h2.Availability
  1391. :p.The most recent version of Downsort is always downloadable and
  1392. file-requestable from Bulletin Board "PC-Square" of the Dutch IBM
  1393. employee PC club.
  1394. Search or request DWNSRT??.* to be independent of the version and
  1395. compression method!
  1396. :p.FIDO-net address:  2&colon.512/4; phone:  31-79-424107 (USR HST-DS).
  1397. :p.Downsort is distributed in area SDSMAX of the international Shareware
  1398. Distribution System.
  1399. :p.There is a fair chance you may find a recent version on one of
  1400. the other bulletin boards, listed in :hdref refid=ause..
  1401. :p.Downsort is distributed in 2 archives:
  1402. :ul.
  1403. :li.A file "DWNSRTxy.ZIP", containing all material you need to run
  1404. Downsort, including documentation, formatted for browsing or printing
  1405. (formfeed is the only printer-control).
  1406. :li.A file "DWNSRSxy.ZIP", containing all SOURCE material.
  1407. :eul.
  1408. :note.'xy' is the version indication,
  1409. for example DWNSRT&VERSION.&SUBVERS..ZIP is the version
  1410. &VERSION..&SUBVERS. runtime package.
  1411. .* -----------------
  1412. :h2.RUN-time material
  1413. :dl tsize=20 termhi=3 compact.
  1414. :dt.WHATSNEW.&VERSION.&SUBVERS.&SUFFIX.
  1415. :dd.Summary of amendments to version &VERSION..&SUBVERS. of Downsort.
  1416. :dt.DOWNSORT.EXE
  1417. :dd.Execution module for OS/2 and DOS (Family Application)
  1418. :rev refid=57.
  1419. :dt.DOWN386.EXE
  1420. :dd.32-bits execution module for OS/2 2.0 or 2.1.
  1421. :dt.DOWN386.ICO
  1422. :dd.ICON file for DOWN386.EXE.
  1423. :erev refid=57.
  1424. :dt.DOWNSORT.DOC
  1425. :dd.Documentation (this file!).
  1426. :dt.DOWNSORT.CFG
  1427. :dd.Sample configuration file.
  1428. This file contains comment lines with extensive instructions how to
  1429. specify the parameters in the file.
  1430. :dt.DOWNSORT.HDR
  1431. :dd.Sample BBS-list header.
  1432. You may use this header, which is only imbedded in the BBS-list,
  1433. to imbed text and/or MECCA-sequences.
  1434. A good candidate for the latter would be &lbrk.onexit&rbrk.,
  1435. which translates to &caret.OFpath.
  1436. See the sample Downsort.HDR file!
  1437. :dt.DOWNSORT.TRL
  1438. :dd.Sample BBS-list trailer.
  1439. :dt.DOWNSORT.BMP
  1440. :dd.Bitmap for the IPF-list, to be included by the IPF compiler.
  1441. :dt.DOWNSORT.INC
  1442. :dd.Sample Include-file for the reports, referenced in Downsort.CFG.
  1443. :dt.DOWNSORT.MAG
  1444. :dd.Sample list of magic names to be included in OKFile(s).
  1445. See BinkleyTerm documentation for details of its format and contents.
  1446. :dt.HPFSDATE.EXE
  1447. :dd.Program to display all three timestamps of a file on an HPFS volume,
  1448. and optionally reset the CREATION date to LASTWRITE date
  1449. (helpful after moving or copying of files).
  1450. Start the program without options to display command syntax and help.
  1451. :dt.PACKING.LST
  1452. :dd.The actual contents of the package (produced with PKUNZIP -V),
  1453. added to the ZIP-file after this was created with the foregoing files
  1454. of this archive.
  1455. This gives at least some authentication!
  1456. :edl.
  1457. .* ---
  1458. :h2.Source material
  1459. :dl tsize=20 termhi=3 compact.
  1460. :dt.DOWNSORT.C
  1461. :dd.Mainline.
  1462. :dt.DOWNCOL.C
  1463. :dd.Data collection functions.
  1464. :dt.DOWNFNT.C
  1465. :dd.Font definition and formatting functions.
  1466. :dt.DOWNPAR.C
  1467. :dd.Processing functions for commandline and Downsort.CFG parameters.
  1468. :dt.DOWNRPT1.C
  1469. :dd.Functions for NEW-, BBS- and EMI-list.
  1470. :dt.DOWNRPT2.C
  1471. :dd.Functions for the IPF-lists.
  1472. :dt.DOWNRPT3.C
  1473. :dd.Functions for the SYSOP-oriented lists, like ORPhan-, OK-, and
  1474. DUPlicate-lists, as well as FILES.BBS files.
  1475. :dt.DOWNRPT4.C
  1476. :dd.Functions for the ALL- and GBL-lists.
  1477. :dt.DOWNSRV.C
  1478. :dd.Miscellaneous services functions.
  1479. :dt.DOWNVARS.C
  1480. :dd.Constants and global variables.
  1481. :dt.DOWNSORT.H
  1482. :dd.Header file, with external definitions of global variables.
  1483. :dt.DOWNFPRO.H
  1484. :dd.Common (global) function prototypes.
  1485. :dt.DOWNSORT.SCR
  1486. :dd.Unformatted documentation file.
  1487. This file includes formatting tags in BOOKMASTER style for printing on
  1488. whatever devices are supported (like IBM page printers).
  1489. This format is compatible and can be formatted on an IBM host system
  1490. with DCF (SCRIPT) as well.
  1491. The file can also processed by the IPF-compiler (just ignore the
  1492. warnings and error-messages!).
  1493. :dt.DOWNSORT.DEF
  1494. :dd.LINK definition file for OS/2 (1.3 and 2.0)
  1495. :rev refid=57.
  1496. :dt.DOWN386.MAK
  1497. :dd.MAKE file for DOWN386.EXE for OS/2 2.0 or 2.1, C Set/2 compiler and
  1498. appropriate program development toolkit (OS/2 2.0 or 2.1)
  1499. :dt.DOWNSORT.MAK
  1500. :dd.MAKE file for Downsort.EXE OS/2 1.3, MS C-compiler 6.00a.
  1501. The program development toolkit (OS/2 1.2/1.3) is needed when using IBM C/2
  1502. 1.1 compiler.
  1503. :erev refid=57.
  1504. :dt.PACKING.LST
  1505. :dd.The actual contents of the package (produced with PKUNZIP -V),
  1506. added to the ZIP-file after this was created with the foregoing files
  1507. of this archive.
  1508. This gives at least some authentication!
  1509. :edl.
  1510. .* --------------------------
  1511. :h2 id=inst.Installation
  1512. :p.With the following directions you should be able to setup and run
  1513. Downsort in a very short time.
  1514. :ol.
  1515. :li.Make a separate directory for Downsort, and make it the current
  1516. default directory every time you run Downsort.
  1517. The separate directory is a recommendation, not a requirement!
  1518. :li.Copy the files Downsort.EXE and Downsort.CFG
  1519. from the Downsort package into this directory.
  1520. :li.Modify (edit) the file Downsort.CFG to specify your environment and
  1521. list requirements.
  1522. The sample file contains comments to help you with this process.
  1523. Most specifications are obvious.
  1524. AreaDat is the most important parameter:
  1525. Downsort won't do anything useful if it cannot find this MAXIMUS
  1526. file.
  1527. See :hdref refid=acfg. for a printed sample.
  1528. :li.You may give Downsort a first shot by just using its name
  1529. on the commandline, with the parameter -H.
  1530. This will show a brief HELP-screen with the possible commandline
  1531. parameter specifications.
  1532. :li.All reports will be created in the Downsort directory
  1533. (unless you specified 'fpath' for the FILES.BBS output).
  1534. Browse the lists to see if you like the contents and titles, and modify
  1535. the CFG-file to your convenience.
  1536. :eol.
  1537. .* -----------------------------
  1538. :h2.Dependencies and restrictions
  1539. :ul.
  1540. :li.Applies to MAXIMUS CBCS 2.01
  1541. :li.Requires OS/2 or DOS 3.0+.
  1542. :li.To convert the IPF-list into VIEW-able format, the IPF-Compiler of the
  1543. OS/2 Program Development Toolkit is required (for the IP2-list the
  1544. corresponding OS/2 2.0 version of this compiler)
  1545. :li.The input FILES.BBS files are assumed to contain only filename.ext
  1546. (the regular 8.3 format, no support for OS/2 1.2+ HPFS format),
  1547. the remainder of the line is considered as file description.
  1548. The filename should be left-aligned (start in position 1).
  1549. :p.If a privilege modifier (&caret.Px) is encountered in FILES.BBS
  1550. then 'x' will become the privilege of all subsequent files (it assumes
  1551. &caret.Px on a SEPARATE line, the REST OF THE LINE IS IGNORED!).
  1552. Heading, comments and blank lines in FILES.BBS are ignored,
  1553. unless /K is specified on the FilFileList line of Downsort.Cfg.
  1554. In that case comments following line 8 (the standard header created by
  1555. Downsort) are preserved.
  1556. The modified privilege might be higher (generally the case) or lower
  1557. than the area-privilege.
  1558. :eul.
  1559. .* -----------
  1560. :h2 id=perf.Storage and Performance
  1561. :p.As a rough estimate of the memory requirements of Downsort,
  1562. use sum of the following elements:
  1563. :ul.
  1564. :li.Program: about 80KB
  1565. :li.Each area: 300 Bytes
  1566. :li.Each file: 48 Bytes for each download file (excluding file
  1567. descriptions and excluding orphans if no orphan-list requested)
  1568. :li.The sum of the file description texts (average 80 bytes/file?)
  1569. :li.The sum of the comments in FILES.BBS if -K option specified
  1570. :eul.
  1571. :p.The maximum number of area's for reporting is 217.
  1572. Your system may have more, but Downsort can currently not work properly
  1573. when more than 217 area's will have to be scanned for files.
  1574. :p.There is a limit on the number of files that can be processed by
  1575. Downsort: about 16350.
  1576. I suppose you'll reach other limits first, for example available memory
  1577. (under DOS).
  1578. But might you reach this limit, then you could do one or more of the
  1579. following:
  1580. :ul compact.
  1581. :li.Use AreaEXclude or AreaINclude to make a selection of groups
  1582. (for example make separate OS/2 and a DOS file-lists).
  1583. Downsort will not collect information of 'excluded' areas.
  1584. :li.If you have many orphans: get rid of them or do not generate an
  1585. orphan report.
  1586. Downsort releases orphan-memory during the data collection phase as soon
  1587. as it knows that a file is an orphan.
  1588. :li.If you have many comment-lines in your FILES.BBS: do not specify /K
  1589. for ALL- and IPF-lists AND do not activate the FILFilePath parameter in
  1590. Downsort.Cfg.
  1591. Downsort will skip comments in FILES.BBS when it does not need them
  1592. for reporting.
  1593. :eul.
  1594. Downsort has been built with a 'guess' about needed stack space.
  1595. The author would appreciate to receive a report for a better estimate.
  1596. :p.Processor performance was an issue for large file-area's before
  1597. version 4.5 of Downsort in the data-collection process.
  1598. That has been partly rewritten in version 4.5 and significantly improved.
  1599. Fastest execution will always be obtained when the input FILES.BBS is
  1600. already sorted on filename.
  1601. .* -------------------------------
  1602. :h2.Problems
  1603. :p.Although I try to prevent the cause of them, there are some
  1604. unresolved problems in the current version of Downsort:
  1605. :ul.
  1606. :li.One user reported unidentified characters in titles.
  1607. :eul.
  1608. .* ---------------------------------------
  1609. :h2.Wishlist
  1610. :p.Downsort is not finished!
  1611. There are a number of wishes and requirements of users and myself to
  1612. include in future releases.
  1613. I list them below not in any particular order, but some seem to be more
  1614. important than others, that differs from SYSOP to SYSOP.
  1615. And some are more easy to implement than others, which depends mainly
  1616. on the author!
  1617. Some wishes don't even make it to be listed below and are implemented
  1618. immediately!
  1619. :ul compact.
  1620. :li.Follow the MAXIMUS development (changing AREA.DAT and other
  1621. structures), and support several versions simultaneously.
  1622. :li.User-configurable options for:
  1623. :ul compact.
  1624. :li.week and month indicators
  1625. :li.indicator for continuation lines in wrapped descriptions
  1626. :li.Avatar codes in FILES.BBS headers
  1627. :li.&lbrk.selectable&rbrk. MECCA control in FILES.BBS
  1628. :li.Private headers in FILES.BBS in stead of the standard headers
  1629. :li.Right margin (line length) and left margin for continuation lines of
  1630. long descriptions, and an optional 'indent' for a download counter.
  1631. :eul.
  1632. :li.Logging to file in stead of stdout to obtain a history file
  1633. of Downsort usage.
  1634. :li.File-selection with MAXIMUS CBCS key/lock parameters in addition to
  1635. or in stead of area privilege levels.
  1636. :li.Support for use of 'barricaded' areas and key/lock.
  1637. :li.List with the format of IPF-list but the contents of NEW-list.
  1638. :li.Automatic removal of 'bad' files (like .BAK-files, obsolete files,
  1639. files that are not in FILES.BBS), maybe move them to a special
  1640. BAD&us.FILE directory.
  1641. Entries in FILES.BBS should be removed accordingly.
  1642. :eul.
  1643. :p.Remember: Was there ever a time that all your wishes were fulfilled?
  1644. That was the most boring time of your life, wasn't it?
  1645. .* ===================================================================
  1646. :h1.Internals
  1647. .* ------
  1648. :h2.Development Environment
  1649. :rev refid=57.
  1650. :p.The family-version of Downsort (for OS/2 1.3 and DOS) is compiled with
  1651. MicroSoft C compiler version 6.00a, with the IBM OS/2 Programming Tools and
  1652. Information (generally called the OS/2 toolkit) under IBM OS/2 Extended
  1653. Edition 1.3 as COMPACT memory model.
  1654. The generated code is at 80286 level (Compiler option /G2), since I
  1655. believe that only very few Bulletin Boards do use an XT these days.
  1656. :p.The 32-bit OS/2 2.0+ only version of Downsort is compiled with IBM
  1657. C&rbl.Set/2 and the 2.0 Toolkit.
  1658. :p.There is only a single set of source files.
  1659. A compiler variable takes care of the selection between 1.3 and 2.0
  1660. calls where necessary.
  1661. :p.Downsort has been tested for MAXIMUS CBCS 2.0, with the following
  1662. Operating Systems:
  1663. :ul compact.
  1664. :li.IBM OS/2 versions 1.3, 2.0 and 2.1
  1665. :li.IBM PC/DOS version 5.0.
  1666. :eul.
  1667. :erev refid=57.
  1668. .* ---------------------------
  1669. :h2.Program Organisation
  1670. :p.The program is organised as follows:
  1671. :ul.
  1672. :li.Initialisation:
  1673. :ul compact.
  1674. :li.Read configuration file.
  1675. :li.Process commandline parameters.
  1676. :eul.
  1677. :p.Commandline parameters may override configuration file parameters.
  1678. :li.Read AREA.DAT file to collect download pathnames
  1679. (only of those area's that will participate this time).
  1680. :li.For each file-area with a privilege not exceeding any list-request:
  1681. :ul.
  1682. :li.Read subdirectory (with find-file-first/next function).
  1683. Take only Normal files: ignore directory entries, Hidden and System
  1684. files and volume labels.
  1685. Also ignore files with the following specifications: FILES.*,
  1686. *.BAK, DIR.?BS and SYSTEM*.?BS.
  1687. :li.For all regular file-entries found in subdirectory:
  1688. :ul compact.
  1689. :li.Get filename.ext, attribute, date, time, size.
  1690. :li.Get file-description from FILES.BBS file.
  1691. The path to the FILES.BBS file is (1) obtained from the "ListFile"
  1692. specification in MAXIMUS AREA.DAT file, or (2) if not specified from the
  1693. "DownLoad" specification (among the download files).
  1694. :rev refid=57.
  1695. :li.Add files with explicit path specifications.
  1696. :erev refid=57.
  1697. :li.Get file privilege 1) from area, 2) from FILES.BBS file if higher.
  1698. :li.When no orphan reporting is required, then drop orphan entries
  1699. area-by-area.
  1700. :eul.
  1701. :eul.
  1702. :li.For the ORP-list:
  1703. :p.If any orphan found, and the orphan-report is requested, create the
  1704. orphan report, with the file-entries sorted on (1) area and (2)
  1705. filename.
  1706. :li.For the BBS-list:
  1707. :ul compact.
  1708. :li.Sort the files primarily on descending file-timestamp (and secundary
  1709. on file-name and area-code).
  1710. :li.Resort the first files on filename if requested.
  1711. :li.Create output file for sorted list of filenames, -descriptions, etc.
  1712. The file is placed in the current subdirectory (which generally will be
  1713. the MAXIMUS directory) with the name Downsort.BBS.
  1714. :li.Copy a headerfile (for a customised MAXIMUS bulletin).
  1715. :li.Put files in formatted outputfile (filename, area#, date, size,
  1716. description), but only if description is found in FILES.BBS.
  1717. Skip files with privilege higher than commandline (or default)
  1718. parameter.
  1719. Precede each line with a privilege-control sequence (&caret.PLx string)
  1720. so that MAXIMUS users below the specified max-priv-level do effectively
  1721. see only the files they can download.
  1722. :li.Include a trailerfile in the outputfile (for a custimised Bulletin).
  1723. :li.Report non-listed files on standard output device (which might be
  1724. re-directed to printer or disk-file).
  1725. :eul.
  1726. :li.If requested, put the above file collection in Downsort.N&tilde.p
  1727. with similar contents and layout as Downsort.BBS, but without
  1728. BBS-control sequences, and without including a header and trailer file.
  1729. Produce a list for the default privilege (HIDDEN), or one for each
  1730. specified privilege.
  1731. :li.If requested, re-sort files on area and then filename or date, and
  1732. create Downsort.A&tilde.p, containing all files (respecting the
  1733. privilege restrictions!).
  1734. Area's with zero files within the applicable privilege limit will not
  1735. be listed at all (will seem non-existing!).
  1736. Produce a list for the default privilege (SYSOP), or one for each
  1737. specified privilege.
  1738. :p.At the end of the list, an area summary report is generated.
  1739. :li.If requested, re-sort files on filename or date only, and create
  1740. Downsort.GBL.
  1741. :li.If requested, re-sort files on area, privilege and filename, and
  1742. create for each area a FILES.BBS-type of file.
  1743. :li.If requested generate a list of probably DUPlicate files.
  1744. :li.If requested generate a list of download-paths: the OK-file
  1745. (not: it will contain only the paths that participated in this run.
  1746. :eul.
  1747. :p.NOTE: the program firstly reads a directory for existing files
  1748. (not Hidden- or System-files, and not Subdirectory or Volumelabel),
  1749. and then reads FILES.BBS to assign a description to each file.
  1750. This means:
  1751. :ul compact.
  1752. :li.If more than 1 matching file-specification in FILES.BBS of the
  1753. involved area is found (note that wild-card specifications in FILES.BBS
  1754. are supported!), than the :hp2.first matching description:ehp2. from
  1755. FILES.BBS will appear in the lists
  1756. (new in version 4.5, was 'last' in previous versions of Downsort).
  1757. :li.Files for which no description is found in FILES.BBS will get
  1758. "---no description available---"
  1759. (or the replacement string you specified in Downsort.CFG)
  1760. in the user reports.
  1761. :li.Files for which no matching filename in FILES.BBS is found will
  1762. be listed in the Orphan report (Downsort.ORP).
  1763. :p.Files for which there is an entry in FILES.BBS, but a corresponding
  1764. file is not found in the directory will be reported as 'offline'.
  1765. :p.In special cases this might become a very large list.
  1766. For example if you collect files in a single directory for different
  1767. area's, all the files of 'the other' areas are reported as orphan.
  1768. This will happen for every area, so each file might even be reported
  1769. many times as orphan!
  1770. Since the Orphan-list is now optional (from version 5.0 on), this list
  1771. can be suppressed.
  1772. :p.Filenames of Orphans appear only in the other reports when the
  1773. FileList request explicitly specifies the Hidden privilege.
  1774. :eul.
  1775. .* -----------
  1776. :h2.Main Data Organisation
  1777. :p.Data structure for access to file information via:
  1778. :ol compact.
  1779. :li.array of file-pointers (for file-sort!)
  1780. :li.pointerchain in file-info structures
  1781. :li.file structure contains pointer to file-description
  1782. :li.file-structure contains pointer to area-information
  1783. :li.Array of area-information
  1784. :eol.
  1785. :p.The structures are shown in the following figure.
  1786. :xmp.
  1787. :cgraphic scale='1.1'.
  1788. :on3270.
  1789.  
  1790. ╔══════╗
  1791. ║  dm  ║
  1792. ╚══════╝
  1793.     │         Array of pointers to structures with file info
  1794.     │      ╔═══════════╦════════════╦═════════════ . . . ══════╗
  1795. (1) └─────>║ *file&lbrk.0&rbrk.  ║  *file&lbrk.1&rbrk.  ║ *file&lbrk.2&rbrk.                 ║
  1796.            ╚═══════════╩════════════╩═════════════ . . . ══════╝
  1797.                  │           │            │
  1798. (2)              v           v            v
  1799. ╔══════╗     ╔══════╗     ╔══════╗     ╔══════╗
  1800. ║  ca  ║ ──> ║ next ║ ──> ║ next ║ ──> ║ next ║ ──> . . .
  1801. ╚══════╝     ╠══════╣     ╠══════╣     ╠══════╣
  1802.  (first-     ║ file-║     ║ file-║     ║ file-║
  1803.  element)    ║ info ║     ║ info ║     ║ info ║    . . .
  1804.              ║ &lbrk.0&rbrk.  ║     ║ &lbrk.1&rbrk.  ║     ║ &lbrk.2&rbrk.  ║
  1805.              ╚══════╝     ╚══════╝     ╚══════╝
  1806.                  │ │         │  │wildcards│ │
  1807.                  │ └──┐      │  └──┐      │ │
  1808.                  │    │      │ ┌──────────┘ │
  1809. (3)              v    │      v v   │ ┌──────┘
  1810.              ╔══════╗ │   ╔══════╗ │ │
  1811.              ║file- ║ │   ║file- ║ │ │(files of
  1812.              ║descr ║ │   ║descr ║ │ │ same area)   . . .
  1813.              ╚══════╝ │   ╚══════╝ │ │
  1814.                       │            │ │
  1815. (4)                   v            v v
  1816.               ╔════════════╦═════════════╦════════ . . . ══════╗
  1817. (5) ┌────────>║  area&lbrk.0&rbrk.   ║   area&lbrk.1&rbrk.   ║                     ║
  1818.     │         ╚════════════╩═════════════╩════════ . . . ══════╝
  1819.     │              array of structures of download info
  1820. ╔══════╗
  1821. ║ area ║
  1822. ╚══════╝
  1823. :off3270.
  1824. :ecgraphic.
  1825. :exmp.
  1826. :p.Schematic overview of Downsort's in-storage database.
  1827. :note.The area-array cannot be sorted itself: this would invalidate the
  1828. pointers in the file-information records!
  1829. :p.The block character image is basically a 10x7 matrix
  1830. (10 vertical and 7 horizontal 'pixels').
  1831. The pixel-array takes two rows at a time, so that each character
  1832. can be represented with 5 rows of 7 horizontal 'double-pixels'.
  1833. Each pixel is displayed as a solid block.
  1834. :xmp.
  1835. :cgraphic scale='1.1'.
  1836. :on3270.
  1837.          1 2 3 4 5 6 7
  1838.         ╔═╦═╦═╦═╦═╦═╦═╗
  1839.         ║-║-║-║-║-║-║-║   line 1    (lower + upper)
  1840.         ╠═╬═╬═╬═╬═╬═╬═╣
  1841.         ║-║-║-║-║-║-║-║        2    (lower + upper)
  1842.         ╠═╬═╬═╬═╬═╬═╬═╣
  1843.         ║-║-║-║-║-║-║-║        3    (lower + upper)
  1844.         ╠═╬═╬═╬═╬═╬═╬═╣
  1845.         ║-║-║-║-║-║-║-║        4    (lower + upper)
  1846.         ╠═╬═╬═╬═╬═╬═╬═╣
  1847.         ║-║-║-║-║-║-║-║        5    (lower + upper)
  1848.         ╚═╩═╩═╩═╩═╩═╩═╝
  1849. :off3270.
  1850. :ecgraphic.
  1851. :exmp.
  1852. :p.Each line is represented by a structure of seven 3-bit fields
  1853. Each 3-bit field represents a basic element:
  1854. :xmp scale='1.1'.
  1855.  value    char       description
  1856.    0                 (blank)
  1857.    1     &BOXBOT.           lower half
  1858.    2       &BOXTOP.         upper half
  1859.    3         &BOX.       lower+upper halves
  1860.    4       &box34.         gray pattern
  1861.    5     &BOXLEFT.           left part of upper and lower half
  1862.    6       &BOXRIGHT.         right part of upper and lower half
  1863.    7         &box14.       gray pattern
  1864.    8      &box12.          gray pattern for not-supported characters
  1865. :exmp.
  1866. :p.The pitch is variable ('proportional font': a variable number of
  1867. horizontal pixels).
  1868. Three fonts are provided with different character-image and size:
  1869. :ol compact.
  1870. :li.6x5 (three lines of max 5 characters)
  1871. :li.10x7 (five lines of max 7 characters)
  1872. :li.8x7 (four lines of max 7 characters)
  1873. :li.10x7 (reverse video image of the 8x7 font)
  1874. :eol.
  1875. :p.Not all ASCII characters are represented in the font tables!
  1876. .* --------------------------------
  1877. :appendix.
  1878. :h1 id=ahis.History of changes
  1879. :p.The paragraphs below show a brief history of changes in Downsort
  1880. (most recent revisions on top of list!).
  1881. :p.Downsort for MAXIMUS CBCS was developed from an OPUS equivalent
  1882. (by the same author).
  1883. Its pre-MAXIMUS history is not really important here and therefore has
  1884. been omitted.
  1885. However the name Downsort has been maintained, so to prevent confusion,
  1886. the version number is inherited (the last version for OPUS was 3.1).
  1887. .*
  1888. :h2.Version 5.7
  1889. :ul compact.
  1890. :li.A 32-bit version (OS/2 2.0+ only) added to runtime package, no
  1891. functional differences with the family version.
  1892. :li.ICON file DOWN386.ICO added for the 32-bit version of Downsort.
  1893. :li.Long areanames (8 characters) are now supported in all reports.
  1894. :li.Changed naming convention of 'FILES.BBS' output files when area's
  1895. with 'long' (more than 3 character) names are used.
  1896. :li.The "FILES.BBS"-type of output (selected with FILFileList in
  1897. Downsort.Cfg) now produces a slightly different header.
  1898. Downsort recognises its own header and an included-file without
  1899. 'multiplication'-effects.
  1900. :li.Explicit path specifications of files in FILES.BBS are now supported.
  1901. As a consequence:
  1902. :ul compact.
  1903. :li.The long format of OK-FileList will contain this explicit path
  1904. in stead of the filearea path.
  1905. :li.It seems more appropriate to list the pathspec in the DUP-FileList
  1906. rather than the file description.
  1907. :eul.
  1908. :hp2.Generic filenames (wildcard specifications) are NOT supported
  1909. (yet)!:ehp2.
  1910. :li.File size and date can be included in FILES.BBS output with the '-L'
  1911. option on the FILFileList line in Downsort.Cfg.
  1912. :li.A new keyword 'NonDupEXT' allows suppression of reporting a file as
  1913. 'duplicate' when it is a member of a pair of files with specified
  1914. extensions.
  1915. Example xyz.SDN and xyz.SDA can be excluded from DupFileList.
  1916. :li.Doc-file now also included as provisional .INF file for OS/2 VIEW.
  1917. :li.Improved Avatar stripping.
  1918. :li.Bug fix for long 'new'-filelist periods (>32000 days).
  1919. :li.Separation between progress signals (stdout) and error messages (stderr)
  1920. and other 'internal' changes:
  1921. :li.Preparations made to remove most commandline parameters.
  1922. It has been redundant for a long time.
  1923. Every Downsort specification on the commandline can also be made via
  1924. Downsort.Cfg.
  1925. Exception: Specification of a configuration file will remain possible!
  1926. Good arguments may change this intention, so please object if I am
  1927. overlooking something.
  1928. :eul.
  1929. .*
  1930. :h2.Version 5.6
  1931. :ul compact.
  1932. :li.In stead of the regular OKFile format (path\*.*), there is now also
  1933. an option (/L) to produce a LONG format of the OKFile, containing
  1934. explicitly all files within privilege with complete file-specification
  1935. (path\filename.ext).
  1936. Useful for file-requests at systems with large directories, and
  1937. especially with CDROM's.
  1938. With this option in effect, the *.* entries will not be generated, so
  1939. file requests are only honored with EXACT filenames: wildcard
  1940. specifications do not work anymore!
  1941. :li.Improved display of long areanames (>3 char) in ALL- and
  1942. IPF-lists.
  1943. :li.Avatar codes may be stripped from comment lines in reports.
  1944. :li.Missing include-files are now only reported when running Downsort in
  1945. -V(erbose) mode.
  1946. :li.Some bug fixes (some of them causing Trap 000D under OS/2):
  1947. :ul compact.
  1948. :li.If 'downsort.cfg' not found, return code 2 is reported, and
  1949. downsort.cfg now closed at end of file.
  1950. :li.Output of FILES.BBS could be erraneous when also IP2-list selected.
  1951. :li.Limit of 217 active area's now relieved (this limit was not
  1952. documented!).
  1953. :li.Improved handling of parameters of FILFilePath-line in the sample
  1954. Downsort.Cfg file.
  1955. Also the explanatory comments are revised.
  1956. :eul.
  1957. :li.'-'-character now precedes the formfeed character in newly created
  1958. FILES.BBS files (version 5.6h+).
  1959. :li.Downsort source is now compilable with IBM C-Set/2 compiler and IBM
  1960. OS/2 2.0 toolkit to obtain a real 32-bit version for OS/2 2.0+.
  1961. :eul.
  1962. .*
  1963. :h2.Version 5.5
  1964. :ul compact.
  1965. :li.Finally(!) a sort capability for area-sequence.
  1966. Areas can now be presented in order of AREA.DAT ('K'eep original
  1967. sequence), sorted on areaname ('A'lphabetically), sorted in
  1968. alphanumeric ('G'roup) sequence or in order of areaINclude ('I').
  1969. The group-sequence is useful with a popular naming convention whereby the
  1970. areaname starts with one or more letters followed by one or more digits.
  1971. Names starting with a digit will be sorted as if it were all numeric,
  1972. and will be sorted accordingly.
  1973. :li.NEW-, BBS-list and EMI-list (see below) can now also be limited in
  1974. length by file-age (period specification in number of Days, Weeks or
  1975. Months).
  1976. :li.A new list-type introduced: EMI-list (new file EMIsions).
  1977. I is a simple list, comparable to NEW-list.
  1978. It has a more compact format, and gives also file-time and the file-size
  1979. (in exact bytes).
  1980. It is especially useful to generate messages with file arrivals
  1981. over the last period (in combination with a period specification).
  1982. :li.Readability improvements in IP2-list.
  1983. :li.Documentation extended with sample output for new users of Downsort.
  1984. :li.Some bug-fixes:
  1985. :ul compact.
  1986. :li.Compares of path- and area-names now case INdependent
  1987. :li.Memory allocation error during collection of comments in FILES.BBS
  1988. :li.Index out-of-range in report preparation phase
  1989. :li.Processing of /K-option for areas with FILES.BBS but otherwise empty.
  1990. :eul.
  1991. :eul.
  1992. .*
  1993. :h2.Version 5.4
  1994. :ul compact.
  1995. :li.Inline comments in FILES.BBS will be reproduced now!
  1996. When AND ONLY WHEN the /K option is specified for All- or IPF-list, or
  1997. for FILFilePath, the original existing comments in FILES.BBS are
  1998. copied into All- or IPF-list or newly created FILES.BBS files.
  1999. So note: /K means now: Keep sequence of FILES.BBS
  2000. :hp2.and Keep comments in FILES.BBS:ehp2. and other lists that support
  2001. the /K option (ALL-, IPF and IP2-list).
  2002. :note./K is now the default sort parameter for FILFilePath, so that you do
  2003. not loose your comments accidently.
  2004. :li.Downsort's interpretation of the meaning of 'orphan' changed a
  2005. little: an 'orphan' is from now on defined as a file for which there is
  2006. no description in any FILES.BBS of all areas pointing to the same
  2007. directory.
  2008. This may reduce improper(?) orphan-reporting by previous versions of
  2009. Downsort considerably when you have physically a single large directory
  2010. of which the files are grouped logically in different areas with separate
  2011. FILES.BBS files.
  2012. :li.Duplicate download directories in OK-files will be suppressed.
  2013. :li.Area-summaries in ALL- and IPF-lists are again sorted alphabetically
  2014. on area-name.
  2015. :li.A check during the data collection phase on maximum supported file
  2016. entries (16350) has been added to prevent problems when exceeding this
  2017. limit.
  2018. :li.Orphan entries in FILES.BBS are now preceeded with '&caret.PS' in
  2019. stead of the unsupported '&caret.PH' (bug fix).
  2020. :li.Some specific adaptations for version 2.0:
  2021. :ul compact.
  2022. :li.All files conforming to filespec 'FILES.*' will not be reported
  2023. anymore.
  2024. :li.Area code will be handled as 9 character string: area-name!
  2025. But in some reports it will be truncated to the first 3 or 4 characters.
  2026. :li.AreaINclude and AreaEXclude are used as 'prefix'.
  2027. Area-name specifications will be treated as group-names:
  2028. you can include or exclude groups of areas starting with the same
  2029. characters.
  2030. :li.The /b, /t, /bt or /tb flag in FILES.BBS will not appear in the
  2031. lists, but only when it appears immediately after the filename.
  2032. It is not stripped from FILES.BBS.
  2033. :eul.
  2034. :li.As experiment a new list has been added: IP2FileList.
  2035. It is a copy if IPF-list, but uses some new formatting features offered
  2036. by the IPF-compiler of the OS/2 2.0-beta toolkit (i.c. &colon.table.).
  2037. The result is a faster generation, but above al a faster compilation
  2038. and a better VIEW.
  2039. VIEWing under OS/2 1.2 or 1.3 is still possible!
  2040. :eul.
  2041. .*
  2042. :h2.Version 5.3
  2043. :ul compact.
  2044. :li.New report added: DUP-list, a simple list, for SYSOP-use only, that
  2045. shows (possibly) duplicate fileNAMES over the area's (the file-extension
  2046. is not considered in the comparison).
  2047. :li.Another new report: OKFile in BinkleyTerm style.
  2048. A list of download paths within privilege, with option to include magic
  2049. names.
  2050. :li.IpfFileList line in Downsort.Cfg now also allows specification of
  2051. the IPF pagesize (maximum number of file-entries per VIEW 'page' or
  2052. 'part').
  2053. :li.Progress signals streamlined, /Q is really silent now!
  2054. :li.Fixed bug which caused Trap 000D under OS/2 (protection violation)
  2055. under some rare conditions.
  2056. The restriction that first area may not be empty or not contain only
  2057. orphans has been removed with this change.
  2058. :li.Support for MAXIMUS CBCS 1.00 removed: only version 1.02 is
  2059. supported (and most likely 2.00 as well).
  2060. :li.Downsort's change-history before version 5.0 removed from
  2061. documentation.
  2062. :li.Use of MicroSoft C Compiler 6.00a: more free memory for DOS users
  2063. (also because of slightly improved program structuring).
  2064. :eul.
  2065. .*
  2066. :h2.Version 5.2
  2067. :ul compact.
  2068. :li.Area selection is now possible within Downsort.
  2069. Two new keywords are provided in Downsort.CFG:
  2070. :hp2.AreaINclude:ehp2. to make reports for selected download area's,
  2071. :hp2.AreaEXclude:ehp2. to omit area's from the reports.
  2072. These keywords have only effect within the collection that would
  2073. otherwise have been reported completely (restricted by AREA.DAT and
  2074. report privilege).
  2075. :li.FILES.BBS has now a peer relation with the directory in stead of
  2076. being subordinate, in Downsort terms of course.
  2077. Filenames and their description in FILES.BBS for which there is no
  2078. corresponding file in the download directory, are now NOT ignored
  2079. anymore.
  2080. In stead the file is reported as 'offline' (on the columns for file-date
  2081. and -size).
  2082. You may replace the word 'offline' with an alternative text.
  2083. :li.Bug repaired that caused some files to be treated as orphan under
  2084. certain rare circumstances.
  2085. And a correction of an error in 'end-of-line' test/search on several
  2086. places.
  2087. :li.As already 'promised' in 5.1, the Area-summary in ALL-list is now in
  2088. order of AREA.DAT.
  2089. :li.Reorganised the documentation to obtain a more logical sequence of
  2090. subjects.
  2091. Due to the growing number of options of Downsort, it became more and
  2092. more difficult to see the trees through the wood.
  2093. I added a number of paragraphs, especially for new users.
  2094. It can be useful for YOU too!
  2095. :eul.
  2096. .*
  2097. :h2.Version 5.1
  2098. :ul compact.
  2099. :li.Since the ORPhan report is optional (changed with version 5.0),
  2100. orphan entries could and now will be removed from internal storage
  2101. during the information collection phase of Downsort, but
  2102. :hp2.only when no orphan-list is requested:ehp2.!
  2103. This is especially useful for the situation where a single large
  2104. directory contains the files of several area's, and whereby the file
  2105. descriptions are contained in different FILES.BBS files.
  2106. Normally this will result in reporting lots of duplicate orphans
  2107. (according to the definition of 'orphan' in Downsort!).
  2108. With this change memory utilisation is lower and sorting faster.
  2109. :li.Another change of this kind: area's with a privilege exceeding
  2110. any reporting privilege are not scanned anymore.
  2111. Apart from lower memory utilisation, this might be useful for CDROM and
  2112. slow disk(ette) systems.
  2113. :li.The maximum number of Top-, Sub- and Bottom-Title lines has been
  2114. extended to 20.
  2115. :li.In addition all lists may now include a 'logo'-file with a new -I
  2116. parameter on the individual report request specification (see sample
  2117. Downsort.CFG).
  2118. The file will be copied into the list without any editing or
  2119. translation.
  2120. It will be positioned directly behind the block-title and before the
  2121. subtitle (if any).
  2122. For example: you may include your BBS-logo or a picture of your system
  2123. configuration, or anything else you want to tell the file-requestors of
  2124. FILES, ALLFILES and/or NEWFILES.
  2125. The IPF-list may also include IPF tags, with artwork, etc.
  2126. It may even include other files itself!
  2127. For FILES.BBS the contents of this Include-file will immediately follow
  2128. the 'standard' header.
  2129. :li.All block-fonts have now a new special character <`> (reversed
  2130. quote), which will be 'printed' as blank (space) with :hp2.half:ehp2.
  2131. the width of a normal character.
  2132. This is useful for fine-alignment (e.g. manually centering) the
  2133. BLOCK-title.
  2134. :li.The chapter on 'titles and headers' has been rewritten to clarify
  2135. the use of all title-options, :hp2.please read it!:ehp2..
  2136. :li.In the SUMMARY of ALL- and IPF-lists the areas themselves
  2137. are not sorted anymore, but presented in sequence of AREAS.CTL
  2138. specification.
  2139. This is based on the assumption that the file area's are in some kind of
  2140. 'natural' order in AREAS.CTL (or maybe it is time to do that now!).
  2141. :li.Descriptions in FILES.BBS are now (again) aligned on column 14 of
  2142. the FILES.bbs file records.
  2143. :li.IPF-list again a little more user-friendly (linking of area's).
  2144. :li.A number of improvements have been applied to the executiontime
  2145. messages (when running in VERBOSE mode).
  2146. :eul.
  2147. .*
  2148. :h2.Version 5.0
  2149. :ul compact.
  2150. :li.Improved IPF-formatting: more colorful, builtin word-wrapping of
  2151. VIEW used for file descriptions (better VIEWable under OS/2 1.3!).
  2152. It should now also compile without errors/warnings.
  2153. Compiling (with IPFC) takes significantly longer however!
  2154. :li.The IPF-list of large filearea's (>200 files) split into parts of
  2155. 200 files to prevent files being left unlisted.
  2156. :li.Top-level title in FileLists shows file-count and byte-count as
  2157. available within the privilege of the list.
  2158. Thus it indicates what is really AVAILable to the user!
  2159. Area-count omitted in lists which are not area-oriented.
  2160. :li.ORPHAN report made OPTIONAL (must be specified to get it!).
  2161. :eul.
  2162. .*
  2163. .* =============================
  2164. :h1 id=ause.World-wide use of Downsort
  2165. :p.PC-Square may be considered as the home-base of Downsort.
  2166. The most recent version is always available there
  2167. (file-requests honoured between 07:00 and 24:00 local time).
  2168. :xmp keep=off.
  2169. :hp2.
  2170. PC-Square               Marcel Stikkelman     Zoetermeer, Netherlands
  2171. 2&colon.512/4                                       31-79-424107
  2172. :p.The following SYSOPs have reported using Downsort on their respective board.
  2173.  
  2174. OS/2-MANiA              Emmanuel Sandorfi     Paris, France
  2175. 2&colon.320/5                                       33-1-64090640
  2176.  
  2177. OS/2 TASK BBS           Rene Carlsen          Skagen, Denmark
  2178. 2&colon.231/910                                     45-98451070
  2179.  
  2180. Grizzilus Maximus       Collin Adams          Preston, UK
  2181. 2&colon.250/121                                     44-772-828975
  2182.  
  2183. Paradigmus Maximus      John Taylor           London, UK
  2184. 2&colon.253/68                                      44-81-566-5393
  2185.  
  2186. Runnin' with the Devil  Roberto Sonzogni      Treviglio BG, Italy
  2187. 2&colon.331/205                                     39-363-302798
  2188.  
  2189. Fernwood                Emitt Dove            Branford CT, USA
  2190. 1&colon.141/209                                     1-203-483-0348
  2191.  
  2192. The Planet Earth        Joel Lambert          Bridgeport CT, USA
  2193. 1&colon.141/455                                     1-203-335-7742
  2194.  
  2195. Bell's Theorem          Jeremy Buhler         Houston TX, USA
  2196. 1&colon.106/7674                                    1-713-777-0633
  2197.  
  2198. OS/2 Shareware          Pete Norloff          Fairfax VA, USA
  2199. 1&colon.109/347                                     1-703-385-4325
  2200.  
  2201. Singing Bear            John Tarbox           Wilmington DE, USA
  2202. 1&colon.150/130                                     1-302-984-2238
  2203.  
  2204. La Jungle BBS           Stephane Seguin       Quebec, Canada
  2205. 1&colon.163/116                                     1-819-595-4917
  2206.  
  2207. 3M Australia            Graham Stair          Sydney, NSW Australia
  2208. 3&colon.711/409                                     61-2-498-9184
  2209. .*
  2210. .* HCC FIDO Groningen-1  Johan Schaaphok  Groningen
  2211. .* 1:153/738             John Cathie      New Westminster, B.C. Canada
  2212. .* 2:245/8               Peter Kaszanics                 , Germany
  2213. .* 2:234/99              Iver Thuessen s                 , Denmark
  2214. :ehp2.
  2215. :exmp.
  2216. :p.I have received reports from others.
  2217. Too many for this list, which is just meant to point to a system
  2218. in your neighbourhood(?).
  2219. You may either logon to one of these boards, or perform a file-request
  2220. of 'FILES' or 'ALLFILES' to get an impression of Downsort's
  2221. capabilities.
  2222. .* =============================
  2223. :h1 id=lsmp.Sample Lists
  2224. :p.Below follow a number of samples of list layouts and contents.
  2225. Not shown are the BBS-, and IPF-lists, since these are screen- rather
  2226. than paper-oriented, with their specific formatting and color settings.
  2227. :p.The dates and sizes in these lists have been manipulated!
  2228. .* ---------
  2229. :h2.ALL-list
  2230. :xmp keep=on.
  2231. :on3270.
  2232.  
  2233. ═══════════════════════════════════════════════════════════════════════════════
  2234.  █▀▀▀▀▀▀   █  ║ OS/2 - Fernwood - New Acquisitions
  2235.  █▄▄▄▄▄   ▄█  ║ Available: 143 files (0.0 MB)
  2236.  ██       ██  ║ Privilege: Disgrace
  2237.  ██       ██  ║ Newest: XLIST233.ZIP  3-22-91  (avail:  7-26-91)
  2238. ───────────────────────────────────────────────────────────────────────────────
  2239. Filename      Size   Date    Description
  2240. ──────────── ───── ───────── ──────────────────────────────────────────────────
  2241. AAFONTS.ZIP     1K  3-22-91  Text from IBM regarding Anti-aliased Fonts.
  2242. AFP_120.LZH     1K  3-22-91  Areafix 1.2 for OS/2.  Permits systems that do
  2243.                              echomail with yours to change their complement of
  2244.                              areas independently.
  2245. :off3270
  2246. :exmp.
  2247. .* ---------
  2248. :h2.GBL-list
  2249. :xmp keep=on.
  2250. :on3270.
  2251.  
  2252. (Sun Jan 05 15:05) Available: 508 files (0 MB)
  2253.                    Maximum privilege shown: Sysop
  2254.                    Newest: BIGBRO.ZIP  3-22-91 (avail:  7-26-91)
  2255.                    Date flag: new on this system since: * = 1 week, + = 1 month
  2256.  
  2257. Filename       Area    Size   Date    Description
  2258. ──────────── ──────── ───── ───────── ─────────────────────────────────────────
  2259. 2COLDIR.ZIP        F3    1K  3-22-91  DoubleDir for OS/2
  2260. 2MONITOR.ZIP       F4    1K  3-22-91  Source and .EXE for running 2 monitors.
  2261. :off3270.
  2262. :exmp.
  2263. .* ---------
  2264. :h2.NEW-list
  2265. :xmp keep=on.
  2266. :on3270.
  2267.  
  2268. (Sun Jan 05 16:14) Last 10 months newest of a total of 508 files (0 MB)
  2269.                    Maximum privilege shown: Sysop
  2270.                    Newest: BIGBRO.ZIP dd  3-22-91 (avail:  7-26-91)
  2271.                    Date flag: new on this system since: * = 1 week, + = 1 month
  2272.  
  2273. Filename       Area    Size   Date    Description
  2274. ──────────── ──────── ───── ───────── ─────────────────────────────────────────
  2275. 2COLDIR.ZIP        F3    1K  3-22-91  DoubleDir for OS/2
  2276. 2MONITOR.ZIP       F4    1K  3-22-91  Source and .EXE for running 2 monitors.
  2277. 8514.PAT           F4    1K  3-22-91  Patch to get 32x32 icons on 8514/a
  2278. :off3270.
  2279. :exmp.
  2280. .* ---------
  2281. :h2.EMI-list
  2282. :xmp keep=on.
  2283. :on3270.
  2284.  
  2285. (Tue Jan 14 21:55) Last 44 weeks newest emissions
  2286.  
  2287. --Filename-- --Date--  -Time-  -Bytes-  ---Description---
  2288. DUMMY.DAT    10-11-91   9:45p       31  Dummy file for Downsort tests +
  2289.              continuation line
  2290. PSOS2.ZIP     3-22-91  11:46p        2  View OS/2 Information on PM like
  2291.              Threads & Process, Memory used, and more.
  2292. :off3270.
  2293. :exmp.
  2294. .* ---------
  2295. :h2.FILES.BBS
  2296. :xmp keep=on.
  2297. :on3270.
  2298.  
  2299. - █▀▀▀▀▀▀   █  ║ OS/2 - Fernwood - New Acquisitions
  2300. - █▄▄▄▄▄   ▄█  ║ Available: 143 files (0.0 MB)
  2301. - ██       ██  ║ Privilege: Disgrace
  2302. - ██       ██  ║ Newest: XLIST233.ZIP  3-22-91 (avail:  7-26-91)
  2303. -──────────────────────────────────────────────────────────────────────────────
  2304. -Filename      Size    Date     Description
  2305. -─────────── ─────── ───────── ────────────────────────────────────────────────
  2306. AAFONTS.ZIP   Text from IBM regarding Anti-aliased Fonts.
  2307. AFP_120.LZH   Areafix 1.2 for OS/2.  Permits systems that do echomail . . . .
  2308. :off3270.
  2309. :exmp.
  2310. :note.File date and size are provided dynamically by Maximus CBCS!
  2311. .* ---------
  2312. :h2.OKfile
  2313. :h3.Short format (default)
  2314. :xmp keep=on.
  2315. @files G:\File\File01\allfiles.zip
  2316. @avail G:\File\File01\allfiles.zip
  2317. @newfiles G:\File\File01\newfiles.zip
  2318. G:\File\Fernwood\*.*
  2319. G:\File\Max\*.*
  2320. :exmp.
  2321. .*
  2322. :h3.LONG format (-L)
  2323. :xmp keep=on.
  2324. @files G:\File\File01\allfiles.zip
  2325. @avail G:\File\File01\allfiles.zip
  2326. @newfiles G:\File\File01\newfiles.zip
  2327. :rev refid=57.
  2328. @DWNSRT55.ZIP G:\File\Fernwood\DWNSRT55.ZIP
  2329. @DWNSRT56.ZIP G:\File\Fernwood\DWNSRT56.ZIP
  2330. @MAXSRT10.ZIP G:\File\Max\MAXSRT10.ZIP
  2331. @MAXSRT11.ZIP G:\File\Max\MAXSRT11.ZIP
  2332. :erev refid=57.
  2333. :exmp.
  2334. .* ---------
  2335. :h2.ORPhan list
  2336. :xmp keep=on.
  2337. :on3270.
  2338.  
  2339. ═══════════════════════════════════════════════════════════════════════════════
  2340.   Area    Filename      Date    FilePath
  2341. ──────── ──────────── ───────── ───────────────────────────────────────────────
  2342.       F1 123R3UPD.ZIP  3-22-91  G:\File\Fernwood\
  2343.       F1 4019DRVR.ZIP  3-22-91  G:\File\Fernwood\
  2344. :off3270.
  2345. :exmp.
  2346. .* =============================
  2347. :h1 id=acfg.Sample Configuration File
  2348. :xmp keep=off
  2349. :cgraphic scale='0.9'.
  2350. :on3270.
  2351. .im downsort.cfg
  2352. :off3270.
  2353. :ecgraphic.
  2354. :exmp.
  2355. :euserdoc.
  2356.